CfnChangeSetProps Struct
Properties for defining a CfnChangeSet.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnChangeSetProps: cdk.CfnChangeSetProps = {
changeSetName: 'changeSetName',
stackName: 'stackName',
// the properties below are optional
capabilities: ['capabilities'],
changeSetType: 'changeSetType',
deploymentMode: 'deploymentMode',
description: 'description',
importExistingResources: false,
includeNestedStacks: false,
notificationArns: ['notificationArns'],
onStackFailure: 'onStackFailure',
roleArn: 'roleArn',
tags: [{
key: 'key',
value: 'value',
}],
templateBody: 'templateBody',
templateUrl: 'templateUrl',
usePreviousTemplate: false,
};
Properties
capabilitiesstring[]capabilitiestyping.List[str]capabilitiesList<String>Capabilitiesstring[]Capabilities*[]*string#The capabilities that are allowed in the stack.
changeSetNamestringchange_set_namestrchangeSetNameStringChangeSetNamestringChangeSetName*stringrequired#The name of the change set.
Must be unique among all change sets associated with the specified stack.
The type of change set operation.
deploymentModestringdeployment_modestrdeploymentModeStringDeploymentModestringDeploymentMode*string#Determines how CloudFormation handles configuration drift during deployment.
A description to help you identify this change set.
importExistingResourcesboolean | IResolvableimport_existing_resourcestyping.Union[bool, IResolvable]importExistingResourcesBooleanImportExistingResourcesboolImportExistingResourcesinterface{}#Indicates if the change set imports resources that already exist.
includeNestedStacksboolean | IResolvableinclude_nested_stackstyping.Union[bool, IResolvable]includeNestedStacksBooleanIncludeNestedStacksboolIncludeNestedStacksinterface{}#Creates a change set for all nested stacks specified in the template.
notificationArnsstring[]notification_arnstyping.List[str]notificationArnsList<String>NotificationArnsstring[]NotificationArns*[]*string#The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
onStackFailurestringon_stack_failurestronStackFailureStringOnStackFailurestringOnStackFailure*string#Determines what action will be taken if stack creation fails.
The ARN of an IAM role that CloudFormation assumes when executing the change set.
The name or unique ID of the stack for which you are creating a change set.
tagsCfnChangeSet.TagsItemsProperty[]tagstyping.List[TagsItemsProperty]tagsList<TagsItemsProperty>TagsTagsItemsProperty[]Tags*[]TagsItemsProperty#Key-value pairs to associate with the change set.
A structure that contains the body of the revised template.
The URL of the file that contains the revised template.
usePreviousTemplateboolean | IResolvableuse_previous_templatetyping.Union[bool, IResolvable]usePreviousTemplateBooleanUsePreviousTemplateboolUsePreviousTemplateinterface{}#Whether to reuse the template associated with the stack to create the change set.