Skip to content
v2.277.0

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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

cfn_change_set_props = cdk.CfnChangeSetProps(
    change_set_name="changeSetName",
    stack_name="stackName",

    # the properties below are optional
    capabilities=["capabilities"],
    change_set_type="changeSetType",
    deployment_mode="deploymentMode",
    description="description",
    import_existing_resources=False,
    include_nested_stacks=False,
    notification_arns=["notificationArns"],
    on_stack_failure="onStackFailure",
    role_arn="roleArn",
    tags=[cdk.CfnChangeSet.TagsItemsProperty(
        key="key",
        value="value"
    )],
    template_body="templateBody",
    template_url="templateUrl",
    use_previous_template=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;

CfnChangeSetProps cfnChangeSetProps = CfnChangeSetProps.builder()
        .changeSetName("changeSetName")
        .stackName("stackName")

        // the properties below are optional
        .capabilities(List.of("capabilities"))
        .changeSetType("changeSetType")
        .deploymentMode("deploymentMode")
        .description("description")
        .importExistingResources(false)
        .includeNestedStacks(false)
        .notificationArns(List.of("notificationArns"))
        .onStackFailure("onStackFailure")
        .roleArn("roleArn")
        .tags(List.of(TagsItemsProperty.builder()
                .key("key")
                .value("value")
                .build()))
        .templateBody("templateBody")
        .templateUrl("templateUrl")
        .usePreviousTemplate(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var cfnChangeSetProps = new CfnChangeSetProps {
    ChangeSetName = "changeSetName",
    StackName = "stackName",

    // the properties below are optional
    Capabilities = new [] { "capabilities" },
    ChangeSetType = "changeSetType",
    DeploymentMode = "deploymentMode",
    Description = "description",
    ImportExistingResources = false,
    IncludeNestedStacks = false,
    NotificationArns = new [] { "notificationArns" },
    OnStackFailure = "onStackFailure",
    RoleArn = "roleArn",
    Tags = new [] { new TagsItemsProperty {
        Key = "key",
        Value = "value"
    } },
    TemplateBody = "templateBody",
    TemplateUrl = "templateUrl",
    UsePreviousTemplate = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"

cfnChangeSetProps := &CfnChangeSetProps{
	ChangeSetName: jsii.String("changeSetName"),
	StackName: jsii.String("stackName"),

	// the properties below are optional
	Capabilities: []*string{
		jsii.String("capabilities"),
	},
	ChangeSetType: jsii.String("changeSetType"),
	DeploymentMode: jsii.String("deploymentMode"),
	Description: jsii.String("description"),
	ImportExistingResources: jsii.Boolean(false),
	IncludeNestedStacks: jsii.Boolean(false),
	NotificationArns: []*string{
		jsii.String("notificationArns"),
	},
	OnStackFailure: jsii.String("onStackFailure"),
	RoleArn: jsii.String("roleArn"),
	Tags: []TagsItemsProperty{
		&TagsItemsProperty{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TemplateBody: jsii.String("templateBody"),
	TemplateUrl: jsii.String("templateUrl"),
	UsePreviousTemplate: jsii.Boolean(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.
stackNamestringstack_namestrstackNameStringStackNamestringStackName*stringrequired#
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.