1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudformation
  6. ChangeSet

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi

    Resource type definition for AWS::CloudFormation::ChangeSet

    Create ChangeSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ChangeSet(name: string, args: ChangeSetArgs, opts?: CustomResourceOptions);
    @overload
    def ChangeSet(resource_name: str,
                  args: ChangeSetArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ChangeSet(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  stack_name: Optional[str] = None,
                  include_nested_stacks: Optional[bool] = None,
                  on_stack_failure: Optional[ChangeSetOnStackFailure] = None,
                  deployment_mode: Optional[ChangeSetDeploymentMode] = None,
                  description: Optional[str] = None,
                  import_existing_resources: Optional[bool] = None,
                  capabilities: Optional[Sequence[ChangeSetCapabilitiesItem]] = None,
                  notification_arns: Optional[Sequence[str]] = None,
                  change_set_type: Optional[ChangeSetType] = None,
                  role_arn: Optional[str] = None,
                  change_set_name: Optional[str] = None,
                  tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None,
                  template_body: Optional[str] = None,
                  template_url: Optional[str] = None,
                  use_previous_template: Optional[bool] = None)
    func NewChangeSet(ctx *Context, name string, args ChangeSetArgs, opts ...ResourceOption) (*ChangeSet, error)
    public ChangeSet(string name, ChangeSetArgs args, CustomResourceOptions? opts = null)
    public ChangeSet(String name, ChangeSetArgs args)
    public ChangeSet(String name, ChangeSetArgs args, CustomResourceOptions options)
    
    type: aws-native:cloudformation:ChangeSet
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_cloudformation_change_set" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ChangeSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ChangeSetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ChangeSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChangeSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChangeSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ChangeSet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ChangeSet resource accepts the following input properties:

    StackName string
    The name or unique ID of the stack for which you are creating a change set.
    Capabilities List<Pulumi.AwsNative.CloudFormation.ChangeSetCapabilitiesItem>
    The capabilities that are allowed in the stack.
    ChangeSetName string
    The name of the change set. Must be unique among all change sets associated with the specified stack.
    ChangeSetType Pulumi.AwsNative.CloudFormation.ChangeSetType
    The type of change set operation.
    DeploymentMode Pulumi.AwsNative.CloudFormation.ChangeSetDeploymentMode
    Determines how CloudFormation handles configuration drift during deployment.
    Description string
    A description to help you identify this change set.
    ImportExistingResources bool
    Indicates if the change set imports resources that already exist.
    IncludeNestedStacks bool
    Creates a change set for all nested stacks specified in the template.
    NotificationArns List<string>
    The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
    OnStackFailure Pulumi.AwsNative.CloudFormation.ChangeSetOnStackFailure
    Determines what action will be taken if stack creation fails.
    RoleArn string
    The ARN of an IAM role that CloudFormation assumes when executing the change set.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    Key-value pairs to associate with the change set.
    TemplateBody string
    A structure that contains the body of the revised template.
    TemplateUrl string
    The URL of the file that contains the revised template.
    UsePreviousTemplate bool
    Whether to reuse the template associated with the stack to create the change set.
    StackName string
    The name or unique ID of the stack for which you are creating a change set.
    Capabilities []ChangeSetCapabilitiesItem
    The capabilities that are allowed in the stack.
    ChangeSetName string
    The name of the change set. Must be unique among all change sets associated with the specified stack.
    ChangeSetType ChangeSetType
    The type of change set operation.
    DeploymentMode ChangeSetDeploymentMode
    Determines how CloudFormation handles configuration drift during deployment.
    Description string
    A description to help you identify this change set.
    ImportExistingResources bool
    Indicates if the change set imports resources that already exist.
    IncludeNestedStacks bool
    Creates a change set for all nested stacks specified in the template.
    NotificationArns []string
    The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
    OnStackFailure ChangeSetOnStackFailure
    Determines what action will be taken if stack creation fails.
    RoleArn string
    The ARN of an IAM role that CloudFormation assumes when executing the change set.
    Tags CreateOnlyTagArgs
    Key-value pairs to associate with the change set.
    TemplateBody string
    A structure that contains the body of the revised template.
    TemplateUrl string
    The URL of the file that contains the revised template.
    UsePreviousTemplate bool
    Whether to reuse the template associated with the stack to create the change set.
    stack_name string
    The name or unique ID of the stack for which you are creating a change set.
    capabilities list("CAPABILITY_IAM" | "CAPABILITY_NAMED_IAM" | "CAPABILITY_AUTO_EXPAND")
    The capabilities that are allowed in the stack.
    change_set_name string
    The name of the change set. Must be unique among all change sets associated with the specified stack.
    change_set_type "CREATE" | "UPDATE" | "IMPORT"
    The type of change set operation.
    deployment_mode "REVERT_DRIFT"
    Determines how CloudFormation handles configuration drift during deployment.
    description string
    A description to help you identify this change set.
    import_existing_resources bool
    Indicates if the change set imports resources that already exist.
    include_nested_stacks bool
    Creates a change set for all nested stacks specified in the template.
    notification_arns list(string)
    The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
    on_stack_failure "DO_NOTHING" | "ROLLBACK" | "DELETE"
    Determines what action will be taken if stack creation fails.
    role_arn string
    The ARN of an IAM role that CloudFormation assumes when executing the change set.
    tags list(object)
    Key-value pairs to associate with the change set.
    template_body string
    A structure that contains the body of the revised template.
    template_url string
    The URL of the file that contains the revised template.
    use_previous_template bool
    Whether to reuse the template associated with the stack to create the change set.
    stackName String
    The name or unique ID of the stack for which you are creating a change set.
    capabilities List<ChangeSetCapabilitiesItem>
    The capabilities that are allowed in the stack.
    changeSetName String
    The name of the change set. Must be unique among all change sets associated with the specified stack.
    changeSetType ChangeSetType
    The type of change set operation.
    deploymentMode ChangeSetDeploymentMode
    Determines how CloudFormation handles configuration drift during deployment.
    description String
    A description to help you identify this change set.
    importExistingResources Boolean
    Indicates if the change set imports resources that already exist.
    includeNestedStacks Boolean
    Creates a change set for all nested stacks specified in the template.
    notificationArns List<String>
    The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
    onStackFailure ChangeSetOnStackFailure
    Determines what action will be taken if stack creation fails.
    roleArn String
    The ARN of an IAM role that CloudFormation assumes when executing the change set.
    tags List<CreateOnlyTag>
    Key-value pairs to associate with the change set.
    templateBody String
    A structure that contains the body of the revised template.
    templateUrl String
    The URL of the file that contains the revised template.
    usePreviousTemplate Boolean
    Whether to reuse the template associated with the stack to create the change set.
    stackName string
    The name or unique ID of the stack for which you are creating a change set.
    capabilities ChangeSetCapabilitiesItem[]
    The capabilities that are allowed in the stack.
    changeSetName string
    The name of the change set. Must be unique among all change sets associated with the specified stack.
    changeSetType ChangeSetType
    The type of change set operation.
    deploymentMode ChangeSetDeploymentMode
    Determines how CloudFormation handles configuration drift during deployment.
    description string
    A description to help you identify this change set.
    importExistingResources boolean
    Indicates if the change set imports resources that already exist.
    includeNestedStacks boolean
    Creates a change set for all nested stacks specified in the template.
    notificationArns string[]
    The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
    onStackFailure ChangeSetOnStackFailure
    Determines what action will be taken if stack creation fails.
    roleArn string
    The ARN of an IAM role that CloudFormation assumes when executing the change set.
    tags CreateOnlyTag[]
    Key-value pairs to associate with the change set.
    templateBody string
    A structure that contains the body of the revised template.
    templateUrl string
    The URL of the file that contains the revised template.
    usePreviousTemplate boolean
    Whether to reuse the template associated with the stack to create the change set.
    stack_name str
    The name or unique ID of the stack for which you are creating a change set.
    capabilities Sequence[ChangeSetCapabilitiesItem]
    The capabilities that are allowed in the stack.
    change_set_name str
    The name of the change set. Must be unique among all change sets associated with the specified stack.
    change_set_type ChangeSetType
    The type of change set operation.
    deployment_mode ChangeSetDeploymentMode
    Determines how CloudFormation handles configuration drift during deployment.
    description str
    A description to help you identify this change set.
    import_existing_resources bool
    Indicates if the change set imports resources that already exist.
    include_nested_stacks bool
    Creates a change set for all nested stacks specified in the template.
    notification_arns Sequence[str]
    The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
    on_stack_failure ChangeSetOnStackFailure
    Determines what action will be taken if stack creation fails.
    role_arn str
    The ARN of an IAM role that CloudFormation assumes when executing the change set.
    tags Sequence[CreateOnlyTagArgs]
    Key-value pairs to associate with the change set.
    template_body str
    A structure that contains the body of the revised template.
    template_url str
    The URL of the file that contains the revised template.
    use_previous_template bool
    Whether to reuse the template associated with the stack to create the change set.
    stackName String
    The name or unique ID of the stack for which you are creating a change set.
    capabilities List<"CAPABILITY_IAM" | "CAPABILITY_NAMED_IAM" | "CAPABILITY_AUTO_EXPAND">
    The capabilities that are allowed in the stack.
    changeSetName String
    The name of the change set. Must be unique among all change sets associated with the specified stack.
    changeSetType "CREATE" | "UPDATE" | "IMPORT"
    The type of change set operation.
    deploymentMode "REVERT_DRIFT"
    Determines how CloudFormation handles configuration drift during deployment.
    description String
    A description to help you identify this change set.
    importExistingResources Boolean
    Indicates if the change set imports resources that already exist.
    includeNestedStacks Boolean
    Creates a change set for all nested stacks specified in the template.
    notificationArns List<String>
    The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
    onStackFailure "DO_NOTHING" | "ROLLBACK" | "DELETE"
    Determines what action will be taken if stack creation fails.
    roleArn String
    The ARN of an IAM role that CloudFormation assumes when executing the change set.
    tags List<Property Map>
    Key-value pairs to associate with the change set.
    templateBody String
    A structure that contains the body of the revised template.
    templateUrl String
    The URL of the file that contains the revised template.
    usePreviousTemplate Boolean
    Whether to reuse the template associated with the stack to create the change set.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ChangeSet resource produces the following output properties:

    ChangeSetId string
    The ARN of the change set.
    CreationTime string
    The time the change set was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    StackId string
    The unique ID of the stack.
    ChangeSetId string
    The ARN of the change set.
    CreationTime string
    The time the change set was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    StackId string
    The unique ID of the stack.
    change_set_id string
    The ARN of the change set.
    creation_time string
    The time the change set was created.
    id string
    The provider-assigned unique ID for this managed resource.
    stack_id string
    The unique ID of the stack.
    changeSetId String
    The ARN of the change set.
    creationTime String
    The time the change set was created.
    id String
    The provider-assigned unique ID for this managed resource.
    stackId String
    The unique ID of the stack.
    changeSetId string
    The ARN of the change set.
    creationTime string
    The time the change set was created.
    id string
    The provider-assigned unique ID for this managed resource.
    stackId string
    The unique ID of the stack.
    change_set_id str
    The ARN of the change set.
    creation_time str
    The time the change set was created.
    id str
    The provider-assigned unique ID for this managed resource.
    stack_id str
    The unique ID of the stack.
    changeSetId String
    The ARN of the change set.
    creationTime String
    The time the change set was created.
    id String
    The provider-assigned unique ID for this managed resource.
    stackId String
    The unique ID of the stack.

    Supporting Types

    ChangeSetCapabilitiesItem, ChangeSetCapabilitiesItemArgs

    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    ChangeSetCapabilitiesItemCapabilityIam
    CAPABILITY_IAM
    ChangeSetCapabilitiesItemCapabilityNamedIam
    CAPABILITY_NAMED_IAM
    ChangeSetCapabilitiesItemCapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    "CAPABILITY_IAM"
    CAPABILITY_IAM
    "CAPABILITY_NAMED_IAM"
    CAPABILITY_NAMED_IAM
    "CAPABILITY_AUTO_EXPAND"
    CAPABILITY_AUTO_EXPAND
    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CapabilityIam
    CAPABILITY_IAM
    CapabilityNamedIam
    CAPABILITY_NAMED_IAM
    CapabilityAutoExpand
    CAPABILITY_AUTO_EXPAND
    CAPABILITY_IAM
    CAPABILITY_IAM
    CAPABILITY_NAMED_IAM
    CAPABILITY_NAMED_IAM
    CAPABILITY_AUTO_EXPAND
    CAPABILITY_AUTO_EXPAND
    "CAPABILITY_IAM"
    CAPABILITY_IAM
    "CAPABILITY_NAMED_IAM"
    CAPABILITY_NAMED_IAM
    "CAPABILITY_AUTO_EXPAND"
    CAPABILITY_AUTO_EXPAND

    ChangeSetDeploymentMode, ChangeSetDeploymentModeArgs

    RevertDrift
    REVERT_DRIFT
    ChangeSetDeploymentModeRevertDrift
    REVERT_DRIFT
    "REVERT_DRIFT"
    REVERT_DRIFT
    RevertDrift
    REVERT_DRIFT
    RevertDrift
    REVERT_DRIFT
    REVERT_DRIFT
    REVERT_DRIFT
    "REVERT_DRIFT"
    REVERT_DRIFT

    ChangeSetOnStackFailure, ChangeSetOnStackFailureArgs

    DoNothing
    DO_NOTHING
    Rollback
    ROLLBACK
    Delete
    DELETE
    ChangeSetOnStackFailureDoNothing
    DO_NOTHING
    ChangeSetOnStackFailureRollback
    ROLLBACK
    ChangeSetOnStackFailureDelete
    DELETE
    "DO_NOTHING"
    DO_NOTHING
    "ROLLBACK"
    ROLLBACK
    "DELETE"
    DELETE
    DoNothing
    DO_NOTHING
    Rollback
    ROLLBACK
    Delete
    DELETE
    DoNothing
    DO_NOTHING
    Rollback
    ROLLBACK
    Delete
    DELETE
    DO_NOTHING
    DO_NOTHING
    ROLLBACK
    ROLLBACK
    DELETE
    DELETE
    "DO_NOTHING"
    DO_NOTHING
    "ROLLBACK"
    ROLLBACK
    "DELETE"
    DELETE

    ChangeSetType, ChangeSetTypeArgs

    Create
    CREATE
    Update
    UPDATE
    Import
    IMPORT
    ChangeSetTypeCreate
    CREATE
    ChangeSetTypeUpdate
    UPDATE
    ChangeSetTypeImport
    IMPORT
    "CREATE"
    CREATE
    "UPDATE"
    UPDATE
    "IMPORT"
    IMPORT
    Create
    CREATE
    Update
    UPDATE
    Import
    IMPORT
    Create
    CREATE
    Update
    UPDATE
    Import
    IMPORT
    CREATE
    CREATE
    UPDATE
    UPDATE
    IMPORT_
    IMPORT
    "CREATE"
    CREATE
    "UPDATE"
    UPDATE
    "IMPORT"
    IMPORT

    CreateOnlyTag, CreateOnlyTagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial