Package software.amazon.awscdk.services.cloudformation

Interface CfnChangeSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChangeSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:05.300Z")
@Stability(Stable)
public interface CfnChangeSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnChangeSet.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChangeSetProps.Builder	A builder for CfnChangeSetProps
static final class	CfnChangeSetProps.Jsii$Proxy	An implementation for CfnChangeSetProps

Method Summary

Modifier and Type	Method	Description
static CfnChangeSetProps.Builder	builder()
default List<String>	getCapabilities()	The capabilities that are allowed in the stack.
String	getChangeSetName()	The name of the change set.
default String	getChangeSetType()	The type of change set operation.
default String	getDeploymentMode()	Determines how CloudFormation handles configuration drift during deployment.
default String	getDescription()	A description to help you identify this change set.
default Object	getImportExistingResources()	Indicates if the change set imports resources that already exist.
default Object	getIncludeNestedStacks()	Creates a change set for all nested stacks specified in the template.
default List<String>	getNotificationArns()	The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
default String	getOnStackFailure()	Determines what action will be taken if stack creation fails.
default String	getRoleArn()	The ARN of an IAM role that CloudFormation assumes when executing the change set.
String	getStackName()	The name or unique ID of the stack for which you are creating a change set.
default List<CfnChangeSet.TagsItemsProperty>	getTags()	Key-value pairs to associate with the change set.
default String	getTemplateBody()	A structure that contains the body of the revised template.
default String	getTemplateUrl()	The URL of the file that contains the revised template.
default Object	getUsePreviousTemplate()	Whether to reuse the template associated with the stack to create the change set.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChangeSetName

@Stability(Stable)
@NotNull
String getChangeSetName()

The name of the change set.

Must be unique among all change sets associated with the specified stack.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-changesetname

getStackName

@Stability(Stable)
@NotNull
String getStackName()

The name or unique ID of the stack for which you are creating a change set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-stackname

getCapabilities

@Stability(Stable)
@Nullable
default List<String> getCapabilities()

The capabilities that are allowed in the stack.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-capabilities

getChangeSetType

@Stability(Stable)
@Nullable
default String getChangeSetType()

The type of change set operation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-changesettype

getDeploymentMode

@Stability(Stable)
@Nullable
default String getDeploymentMode()

Determines how CloudFormation handles configuration drift during deployment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-deploymentmode

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description to help you identify this change set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-description

getImportExistingResources

@Stability(Stable)
@Nullable
default Object getImportExistingResources()

Indicates if the change set imports resources that already exist.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-importexistingresources

getIncludeNestedStacks

@Stability(Stable)
@Nullable
default Object getIncludeNestedStacks()

Creates a change set for all nested stacks specified in the template.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-includenestedstacks

getNotificationArns

@Stability(Stable)
@Nullable
default List<String> getNotificationArns()

The ARNs of Amazon SNS topics that CloudFormation associates with the stack.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-notificationarns

getOnStackFailure

@Stability(Stable)
@Nullable
default String getOnStackFailure()

Determines what action will be taken if stack creation fails.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-onstackfailure

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The ARN of an IAM role that CloudFormation assumes when executing the change set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-rolearn

getTags

@Stability(Stable)
@Nullable
default List<CfnChangeSet.TagsItemsProperty> getTags()

Key-value pairs to associate with the change set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-tags

getTemplateBody

@Stability(Stable)
@Nullable
default String getTemplateBody()

A structure that contains the body of the revised template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-templatebody

getTemplateUrl

@Stability(Stable)
@Nullable
default String getTemplateUrl()

The URL of the file that contains the revised template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-templateurl

getUsePreviousTemplate

@Stability(Stable)
@Nullable
default Object getUsePreviousTemplate()

Whether to reuse the template associated with the stack to create the change set.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-changeset.html#cfn-cloudformation-changeset-useprevioustemplate

builder

@Stability(Stable)
static CfnChangeSetProps.Builder builder()

Returns:

a CfnChangeSetProps.Builder of CfnChangeSetProps