Protected Readonly Internal_AWS CloudFormation resource properties.
This object is returned via cfnProperties
ReadonlycfnOptions for this resource, such as condition, update policy etc.
Protected ReadonlycfnReadonlycfnAWS resource type.
ReadonlylogicalThe logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
ReadonlynodeThe tree node.
ReadonlystackThe stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly).
ReadonlytagsTag Manager which manages the tags for this resource
Static ReadonlyCFN_The CloudFormation resource type name for this resource class.
InternalThe list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS .
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS .
Protectedcfnthe stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
Specifies the domain of the storage system that is used for file transfers.
Specifies the domain of the storage system that is used for file transfers.
The virtual private cloud (VPC) endpoint settings that are configured for your server.
The virtual private cloud (VPC) endpoint settings that are configured for your server.
The type of endpoint that you want your server to use.
The type of endpoint that you want your server to use.
Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .
Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .
The mode of authentication for a server.
The mode of authentication for a server.
Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint.
Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events.
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
Specifies a string to display when users connect to a server.
Specifies a string to display when users connect to a server.
The protocol settings that are configured for your server.
The protocol settings that are configured for your server.
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
Specifies whether or not performance for your Amazon S3 directories is optimized.
Specifies whether or not performance for your Amazon S3 directories is optimized.
Specifies the name of the security policy for the server.
Specifies the name of the security policy for the server.
A reference to a Server resource.
Specifies the log groups to which your server logs are sent.
Specifies the log groups to which your server logs are sent.
Key-value pairs that can be used to group and search for servers.
Key-value pairs that can be used to group and search for servers.
ProtectedupdatedProtectedupdatedReturn properties modified after initiation
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
InternalCalled by the addDependency helper function in order to realize a direct
dependency between two resources that are directly defined in the same
stacks.
Use resource.addDependency to define the dependency between two resources,
which also takes stack boundaries into account.
InternalLock the logicalId of the element and do not allow any updates (e.g. via overrideLogicalId)
This is needed in cases where you are consuming the LogicalID of an element prior to synthesis and you need to not allow future changes to the id since doing so would cause the value you just consumed to differ from the synth time value of the logicalId.
For example:
const bucket = new Bucket(stack, 'Bucket'); stack.exportValue(bucket.bucketArn) <--- consuming the logicalId bucket.overrideLogicalId('NewLogicalId') <--- updating logicalId
You should most likely never need to use this method, and if you are implementing a feature that requires this, make sure you actually require it.
InternalRemove a dependency between this resource and other resources in the same stack.
Protected_InternalCalled during synthesize to render the logical ID of this element. If
overrideLogicalId was it will be used, otherwise, we will allocate the
logical ID through the stack.
InternalEmits CloudFormation for this resource.
Syntactic sugar for addOverride(path, undefined).
The path of the value to delete
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
Add a value to the CloudFormation Resource Metadata
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
Adds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most
programming languages you will need to write this as "\\." because the
`` itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
The value. Could be primitive or complex.
Adds an override that deletes the value of a property from the resource definition.
The path to the property.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
The path of the property
The value
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
The reference strength to use for this resource.
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
Optionaloptions: RemovalPolicyOptionsReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
The name of the attribute.
OptionaltypeHint: ResolutionTypeHintRetrieve a value value from the CloudFormation Resource Metadata
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
Examines the CloudFormation resource and discloses attributes
tree inspector to collect and process attributes
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
Get a shallow copy of dependencies between this resource and other resources in the same stack.
Overrides the auto-generated logical ID with a specific ID.
The new logical ID to use for this stack element.
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
ProtectedrenderReplaces one dependency with another.
The dependency to replace
The new dependency to add
ProtectedshouldCan be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
true if the resource should be included or false is the resource
should be omitted.
a string representation of this resource
ProtectedvalidateApplies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
The mixins to apply
This construct for chaining
Static_InternalBuild a CfnServer from CloudFormation properties
A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource. Used in the @aws-cdk/cloudformation-include module.
StaticarnStaticisReturns true if a construct is a stack element (i.e. part of the
synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different
versions of this library to be included in the same stack.
The construct as a stack element or undefined if it is not a stack element.
StaticisCheck whether the given object is a CfnResource
StaticisChecks whether the given object is a CfnServer
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
Reusable CDK construct for a compliant Transfer Family SFTP Server. Specifically, enforces VPC configuration, logging, and security policy