Package software.amazon.awscdk

Class CfnChangeSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.CfnChangeSet
All Implemented Interfaces:
IInspectable, IChangeSetRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:01.576Z") @Stability(Stable) public class CfnChangeSet extends CfnResource implements IInspectable, IChangeSetRef, ITaggableV2
Resource type definition for AWS::CloudFormation::ChangeSet.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnChangeSet cfnChangeSet = CfnChangeSet.Builder.create(this, "MyCfnChangeSet")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnChangeSet

      protected CfnChangeSet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnChangeSet

      protected CfnChangeSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnChangeSet

      @Stability(Stable) public CfnChangeSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnChangeSetProps props)
      Create a new AWS::CloudFormation::ChangeSet.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnChangeSet

      @Stability(Stable) @NotNull public static Boolean isCfnChangeSet(@NotNull Object x)
      Checks whether the given object is a CfnChangeSet.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrChangeSetId

      @Stability(Stable) @NotNull public String getAttrChangeSetId()
      The ARN of the change set.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time the change set was created.

    • getAttrStackId

      @Stability(Stable) @NotNull public String getAttrStackId()
      The unique ID of the stack.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getChangeSetRef

      @Stability(Stable) @NotNull public ChangeSetReference getChangeSetRef()
      A reference to a ChangeSet resource.
      Specified by:
      getChangeSetRef in interface IChangeSetRef

    • getChangeSetName

      @Stability(Stable) @NotNull public String getChangeSetName()
      The name of the change set.

    • setChangeSetName

      @Stability(Stable) public void setChangeSetName(@NotNull String value)
      The name of the change set.

    • getStackName

      @Stability(Stable) @NotNull public String getStackName()
      The name or unique ID of the stack for which you are creating a change set.

    • setStackName

      @Stability(Stable) public void setStackName(@NotNull String value)
      The name or unique ID of the stack for which you are creating a change set.

    • getCapabilities

      @Stability(Stable) @Nullable public List<String> getCapabilities()
      The capabilities that are allowed in the stack.

    • setCapabilities

      @Stability(Stable) public void setCapabilities(@Nullable List<String> value)
      The capabilities that are allowed in the stack.

    • getChangeSetType

      @Stability(Stable) @Nullable public String getChangeSetType()
      The type of change set operation.

    • setChangeSetType

      @Stability(Stable) public void setChangeSetType(@Nullable String value)
      The type of change set operation.

    • getDeploymentMode

      @Stability(Stable) @Nullable public String getDeploymentMode()
      Determines how CloudFormation handles configuration drift during deployment.

    • setDeploymentMode

      @Stability(Stable) public void setDeploymentMode(@Nullable String value)
      Determines how CloudFormation handles configuration drift during deployment.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description to help you identify this change set.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description to help you identify this change set.

    • getImportExistingResources

      @Stability(Stable) @Nullable public Object getImportExistingResources()
      Indicates if the change set imports resources that already exist.

      Returns union: either Boolean or IResolvable

    • setImportExistingResources

      @Stability(Stable) public void setImportExistingResources(@Nullable Boolean value)
      Indicates if the change set imports resources that already exist.

    • setImportExistingResources

      @Stability(Stable) public void setImportExistingResources(@Nullable IResolvable value)
      Indicates if the change set imports resources that already exist.

    • getIncludeNestedStacks

      @Stability(Stable) @Nullable public Object getIncludeNestedStacks()
      Creates a change set for all nested stacks specified in the template.

      Returns union: either Boolean or IResolvable

    • setIncludeNestedStacks

      @Stability(Stable) public void setIncludeNestedStacks(@Nullable Boolean value)
      Creates a change set for all nested stacks specified in the template.

    • setIncludeNestedStacks

      @Stability(Stable) public void setIncludeNestedStacks(@Nullable IResolvable value)
      Creates a change set for all nested stacks specified in the template.

    • getNotificationArns

      @Stability(Stable) @Nullable public List<String> getNotificationArns()
      The ARNs of Amazon SNS topics that CloudFormation associates with the stack.

    • setNotificationArns

      @Stability(Stable) public void setNotificationArns(@Nullable List<String> value)
      The ARNs of Amazon SNS topics that CloudFormation associates with the stack.

    • getOnStackFailure

      @Stability(Stable) @Nullable public String getOnStackFailure()
      Determines what action will be taken if stack creation fails.

    • setOnStackFailure

      @Stability(Stable) public void setOnStackFailure(@Nullable String value)
      Determines what action will be taken if stack creation fails.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The ARN of an IAM role that CloudFormation assumes when executing the change set.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The ARN of an IAM role that CloudFormation assumes when executing the change set.

    • getTags

      @Stability(Stable) @Nullable public List<CfnChangeSet.TagsItemsProperty> getTags()
      Key-value pairs to associate with the change set.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnChangeSet.TagsItemsProperty> value)
      Key-value pairs to associate with the change set.

    • getTemplateBody

      @Stability(Stable) @Nullable public String getTemplateBody()
      A structure that contains the body of the revised template.

    • setTemplateBody

      @Stability(Stable) public void setTemplateBody(@Nullable String value)
      A structure that contains the body of the revised template.

    • getTemplateUrl

      @Stability(Stable) @Nullable public String getTemplateUrl()
      The URL of the file that contains the revised template.

    • setTemplateUrl

      @Stability(Stable) public void setTemplateUrl(@Nullable String value)
      The URL of the file that contains the revised template.

    • getUsePreviousTemplate

      @Stability(Stable) @Nullable public Object getUsePreviousTemplate()
      Whether to reuse the template associated with the stack to create the change set.

      Returns union: either Boolean or IResolvable

    • setUsePreviousTemplate

      @Stability(Stable) public void setUsePreviousTemplate(@Nullable Boolean value)
      Whether to reuse the template associated with the stack to create the change set.

    • setUsePreviousTemplate

      @Stability(Stable) public void setUsePreviousTemplate(@Nullable IResolvable value)
      Whether to reuse the template associated with the stack to create the change set.