class CfnServer (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Transfer.CfnServer |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnServer |
![]() | software.amazon.awscdk.services.transfer.CfnServer |
![]() | aws_cdk.aws_transfer.CfnServer |
![]() | aws-cdk-lib » aws_transfer » CfnServer |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS .
When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId
property that is assigned to the newly created server.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-server.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const cfnServer = new transfer.CfnServer(this, 'MyCfnServer', /* all optional props */ {
certificate: 'certificate',
domain: 'domain',
endpointDetails: {
addressAllocationIds: ['addressAllocationIds'],
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
vpcEndpointId: 'vpcEndpointId',
vpcId: 'vpcId',
},
endpointType: 'endpointType',
identityProviderDetails: {
directoryId: 'directoryId',
function: 'function',
invocationRole: 'invocationRole',
sftpAuthenticationMethods: 'sftpAuthenticationMethods',
url: 'url',
},
identityProviderType: 'identityProviderType',
loggingRole: 'loggingRole',
postAuthenticationLoginBanner: 'postAuthenticationLoginBanner',
preAuthenticationLoginBanner: 'preAuthenticationLoginBanner',
protocolDetails: {
as2Transports: ['as2Transports'],
passiveIp: 'passiveIp',
setStatOption: 'setStatOption',
tlsSessionResumptionMode: 'tlsSessionResumptionMode',
},
protocols: ['protocols'],
s3StorageOptions: {
directoryListingOptimization: 'directoryListingOptimization',
},
securityPolicyName: 'securityPolicyName',
structuredLogDestinations: ['structuredLogDestinations'],
tags: [{
key: 'key',
value: 'value',
}],
workflowDetails: {
onPartialUpload: [{
executionRole: 'executionRole',
workflowId: 'workflowId',
}],
onUpload: [{
executionRole: 'executionRole',
workflowId: 'workflowId',
}],
},
});
Initializer
new CfnServer(scope: Construct, id: string, props?: CfnServerProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Server Props
Construct Props
Name | Type | Description |
---|---|---|
certificate? | string | The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. |
domain? | string | Specifies the domain of the storage system that is used for file transfers. |
endpoint | IResolvable | Endpoint | The virtual private cloud (VPC) endpoint settings that are configured for your server. |
endpoint | string | The type of endpoint that you want your server to use. |
identity | IResolvable | Identity | Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY . |
identity | string | The mode of authentication for a server. |
logging | string | 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 EFSevents. |
post | string | Specifies a string to display when users connect to a server. This string is displayed after the user authenticates. |
pre | string | Specifies a string to display when users connect to a server. |
protocol | IResolvable | Protocol | The protocol settings that are configured for your server. |
protocols? | string[] | Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. |
s3 | IResolvable | S3 | Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default. |
security | string | Specifies the name of the security policy for the server. |
structured | string[] | Specifies the log groups to which your server logs are sent. |
tags? | Cfn [] | Key-value pairs that can be used to group and search for servers. |
workflow | IResolvable | Workflow | Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. |
certificate?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
Required when Protocols
is set to FTPS
.
To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide .
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide .
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide .
Certificates with the following cryptographic algorithms and key sizes are supported:
- 2048-bit RSA (RSA_2048)
- 4096-bit RSA (RSA_4096)
- Elliptic Prime Curve 256 bit (EC_prime256v1)
- Elliptic Prime Curve 384 bit (EC_secp384r1)
- Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
domain?
Type:
string
(optional)
Specifies the domain of the storage system that is used for file transfers.
There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
endpointDetails?
Type:
IResolvable
|
Endpoint
(optional)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
endpointType?
Type:
string
(optional)
The type of endpoint that you want your server to use.
You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers withEndpointType=VPC_ENDPOINT
in your AWS account on or before May 19, 2021, you will not be affected. After this date, useEndpointType
=VPC
.For more information, see Discontinuing the use of VPC_ENDPOINT .
It is recommended that you use
VPC
as theEndpointType
. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible withEndpointType
set toVPC_ENDPOINT
.
identityProviderDetails?
Type:
IResolvable
|
Identity
(optional)
Required when IdentityProviderType
is set to AWS_DIRECTORY_SERVICE
, AWS _LAMBDA
or API_GATEWAY
.
Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE
or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when IdentityProviderType
is set to SERVICE_MANAGED
.
identityProviderType?
Type:
string
(optional)
The mode of authentication for a server.
The default value is SERVICE_MANAGED
, which allows you to store and access user credentials within the AWS Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function
parameter for the IdentityProviderDetails
data type.
loggingRole?
Type:
string
(optional)
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 EFSevents.
When set, you can view user activity in your CloudWatch logs.
postAuthenticationLoginBanner?
Type:
string
(optional)
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
preAuthenticationLoginBanner?
Type:
string
(optional)
Specifies a string to display when users connect to a server.
This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
protocolDetails?
Type:
IResolvable
|
Protocol
(optional)
The protocol settings that are configured for your server.
- To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIp
parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - To ignore the error that is generated when the client attempts to use the
SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use theSetStatOption
parameter. To have the AWS Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. - To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
The Protocols
parameter is an array of strings.
Allowed values : One or more of SFTP
, FTPS
, FTP
, AS2
protocols?
Type:
string[]
(optional)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSHFTPS
(File Transfer Protocol Secure): File transfer with TLS encryptionFTP
(File Transfer Protocol): Unencrypted file transferAS2
(Applicability Statement 2): used for transporting structured business-to-business data
- If you select
FTPS
, you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.- If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
.- If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated.- If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
.- If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
The Protocols
parameter is an array of strings.
Allowed values : One or more of SFTP
, FTPS
, FTP
, AS2
s3StorageOptions?
Type:
IResolvable
|
S3
(optional)
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to FILE
if you want a mapping to have a file target.
securityPolicyName?
Type:
string
(optional)
Specifies the name of the security policy for the server.
structuredLogDestinations?
Type:
string[]
(optional)
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
tags?
Type:
Cfn
[]
(optional)
Key-value pairs that can be used to group and search for servers.
workflowDetails?
Type:
IResolvable
|
Workflow
(optional)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.
Properties
Name | Type | Description |
---|---|---|
attr | string | Specifies the unique Amazon Resource Name (ARN) of the server. |
attr | string[] | The list of egress IP addresses of this server. |
attr | string | Specifies the unique system-assigned identifier for a server that you instantiate. |
attr | string | |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
certificate? | string | The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. |
domain? | string | Specifies the domain of the storage system that is used for file transfers. |
endpoint | IResolvable | Endpoint | The virtual private cloud (VPC) endpoint settings that are configured for your server. |
endpoint | string | The type of endpoint that you want your server to use. |
identity | IResolvable | Identity | Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY . |
identity | string | The mode of authentication for a server. |
logging | string | 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 EFSevents. |
post | string | Specifies a string to display when users connect to a server. |
pre | string | Specifies a string to display when users connect to a server. |
protocol | IResolvable | Protocol | The protocol settings that are configured for your server. |
protocols? | string[] | Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. |
s3 | IResolvable | S3 | Specifies whether or not performance for your Amazon S3 directories is optimized. |
security | string | Specifies the name of the security policy for the server. |
structured | string[] | Specifies the log groups to which your server logs are sent. |
tags | Cfn [] | Key-value pairs that can be used to group and search for servers. |
workflow | IResolvable | Workflow | Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
Specifies the unique Amazon Resource Name (ARN) of the server.
attrAs2ServiceManagedEgressIpAddresses
Type:
string[]
The 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.
attrServerId
Type:
string
Specifies the unique system-assigned identifier for a server that you instantiate.
attrState
Type:
string
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The 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)
.
node
Type:
Node
The tree node.
ref
Type:
string
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
certificate?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
domain?
Type:
string
(optional)
Specifies the domain of the storage system that is used for file transfers.
endpointDetails?
Type:
IResolvable
|
Endpoint
(optional)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
endpointType?
Type:
string
(optional)
The type of endpoint that you want your server to use.
identityProviderDetails?
Type:
IResolvable
|
Identity
(optional)
Required when IdentityProviderType
is set to AWS_DIRECTORY_SERVICE
, AWS _LAMBDA
or API_GATEWAY
.
identityProviderType?
Type:
string
(optional)
The mode of authentication for a server.
loggingRole?
Type:
string
(optional)
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 EFSevents.
postAuthenticationLoginBanner?
Type:
string
(optional)
Specifies a string to display when users connect to a server.
This string is displayed after the user authenticates.
preAuthenticationLoginBanner?
Type:
string
(optional)
Specifies a string to display when users connect to a server.
protocolDetails?
Type:
IResolvable
|
Protocol
(optional)
The protocol settings that are configured for your server.
protocols?
Type:
string[]
(optional)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
s3StorageOptions?
Type:
IResolvable
|
S3
(optional)
Specifies whether or not performance for your Amazon S3 directories is optimized.
This is disabled by default.
securityPolicyName?
Type:
string
(optional)
Specifies the name of the security policy for the server.
structuredLogDestinations?
Type:
string[]
(optional)
Specifies the log groups to which your server logs are sent.
tagsRaw?
Type:
Cfn
[]
(optional)
Key-value pairs that can be used to group and search for servers.
workflowDetails?
Type:
IResolvable
|
Workflow
(optional)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
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.](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.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
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.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns 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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
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.](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.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }