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
capabilitiesoptionalstring[]capabilitiesoptionaltyping.List[str]capabilitiesoptionalList<String>Capabilitiesoptionalstring[]Capabilitiesoptional*[]*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.
changeSetTypeoptionalstringchange_set_typeoptionalstrchangeSetTypeoptionalStringChangeSetTypeoptionalstringChangeSetTypeoptional*string#The type of change set operation.
deploymentModeoptionalstringdeployment_modeoptionalstrdeploymentModeoptionalStringDeploymentModeoptionalstringDeploymentModeoptional*string#Determines how CloudFormation handles configuration drift during deployment.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description to help you identify this change set.
importExistingResourcesoptionalboolean | IResolvableimport_existing_resourcesoptionaltyping.Union[bool, IResolvable]importExistingResourcesoptionalBooleanImportExistingResourcesoptionalboolImportExistingResourcesoptionalinterface{}#Indicates if the change set imports resources that already exist.
includeNestedStacksoptionalboolean | IResolvableinclude_nested_stacksoptionaltyping.Union[bool, IResolvable]includeNestedStacksoptionalBooleanIncludeNestedStacksoptionalboolIncludeNestedStacksoptionalinterface{}#Creates a change set for all nested stacks specified in the template.
notificationArnsoptionalstring[]notification_arnsoptionaltyping.List[str]notificationArnsoptionalList<String>NotificationArnsoptionalstring[]NotificationArnsoptional*[]*string#The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
onStackFailureoptionalstringon_stack_failureoptionalstronStackFailureoptionalStringOnStackFailureoptionalstringOnStackFailureoptional*string#Determines what action will be taken if stack creation fails.
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string#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.
tagsoptionalCfnChangeSet.TagsItemsProperty[]tagsoptionaltyping.List[TagsItemsProperty]tagsoptionalList<TagsItemsProperty>TagsoptionalTagsItemsProperty[]Tagsoptional*[]TagsItemsProperty#Key-value pairs to associate with the change set.
templateBodyoptionalstringtemplate_bodyoptionalstrtemplateBodyoptionalStringTemplateBodyoptionalstringTemplateBodyoptional*string#A structure that contains the body of the revised template.
templateUrloptionalstringtemplate_urloptionalstrtemplateUrloptionalStringTemplateUrloptionalstringTemplateUrloptional*string#The URL of the file that contains the revised template.
usePreviousTemplateoptionalboolean | IResolvableuse_previous_templateoptionaltyping.Union[bool, IResolvable]usePreviousTemplateoptionalBooleanUsePreviousTemplateoptionalboolUsePreviousTemplateoptionalinterface{}#Whether to reuse the template associated with the stack to create the change set.