class CfnStack (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CloudFormation.CfnStack |
![]() | software.amazon.awscdk.services.cloudformation.CfnStack |
![]() | aws_cdk.aws_cloudformation.CfnStack |
![]() | @aws-cdk/aws-cloudformation » CfnStack |
Implements
IConstruct
, IConstruct
, IDependable
, IInspectable
A CloudFormation AWS::CloudFormation::Stack
.
The AWS::CloudFormation::Stack
resource nests a stack as a resource in a top-level template.
You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. *NestedStackOutputName*
.
We strongly recommend that updates to nested stacks are run from the parent stack.
When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks. For more information, see CloudFormation stack updates .
You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudformation from '@aws-cdk/aws-cloudformation';
const cfnStack = new cloudformation.CfnStack(this, 'MyCfnStack', {
templateUrl: 'templateUrl',
// the properties below are optional
notificationArns: ['notificationArns'],
parameters: {
parametersKey: 'parameters',
},
tags: [{
key: 'key',
value: 'value',
}],
timeoutInMinutes: 123,
});
Initializer
new CfnStack(scope: Construct, id: string, props: CfnStackProps)
Parameters
- scope
Construct
— - scope in which this resource is defined. - id
string
— - scoped id of the resource. - props
Cfn
— - resource properties.Stack Props
Create a new AWS::CloudFormation::Stack
.
Construct Props
Name | Type | Description |
---|---|---|
template | string | Location of file containing the template body. |
notification | string[] | The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. |
parameters? | IResolvable | { [string]: string } | The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. |
tags? | Cfn [] | Key-value pairs to associate with this stack. |
timeout | number | The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state. |
templateUrl
Type:
string
Location of file containing the template body.
The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template anatomy .
Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
notificationArns?
Type:
string[]
(optional)
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.
You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
parameters?
Type:
IResolvable
| { [string]: string }
(optional)
The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
If you use the
Ref
function to pass a parameter value to a nested stack, comma-delimited list parameters must be of typeString
. In other words, you can't pass values that are of typeCommaDelimitedList
to nested stacks.
Conditional. Required if the nested stack requires input parameters.
Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
tags?
Type:
Cfn
[]
(optional)
Key-value pairs to associate with this stack.
AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
timeoutInMinutes?
Type:
number
(optional)
The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE
state.
The default is no timeout. When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE
state, it marks the nested stack resource as CREATE_COMPLETE
in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE
, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
Updates aren't supported.
Properties
Name | Type | Description |
---|---|---|
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 | Construct | The construct tree node associated with this construct. |
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 | Key-value pairs to associate with this stack. |
template | string | Location of file containing the template body. |
notification | string[] | The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. |
parameters? | IResolvable | { [string]: string } | The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. |
timeout | number | The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
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:
Construct
The construct tree node associated with this construct.
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
Key-value pairs to associate with this stack.
AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
templateUrl
Type:
string
Location of file containing the template body.
The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template anatomy .
Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
notificationArns?
Type:
string[]
(optional)
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.
You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
parameters?
Type:
IResolvable
| { [string]: string }
(optional)
The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
If you use the
Ref
function to pass a parameter value to a nested stack, comma-delimited list parameters must be of typeString
. In other words, you can't pass values that are of typeCommaDelimitedList
to nested stacks.
Conditional. Required if the nested stack requires input parameters.
Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
timeoutInMinutes?
Type:
number
(optional)
The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE
state.
The default is no timeout. When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE
state, it marks the nested stack resource as CREATE_COMPLETE
in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE
, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
Updates aren't supported.
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 | 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. |
override | Overrides the auto-generated logical ID with a specific ID. |
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)
.
addDependsOn(target)
public addDependsOn(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.
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
).
getAtt(attributeName)
public getAtt(attributeName: string): Reference
Parameters
- attributeName
string
— The name of the attribute.
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.
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.
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 }