We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- Stack
Name string - The name or unique ID of the stack for which you are creating a change set.
- Capabilities
List<Pulumi.
Aws Native. Cloud Formation. Change Set Capabilities Item> - The capabilities that are allowed in the stack.
- Change
Set stringName - The name of the change set. Must be unique among all change sets associated with the specified stack.
- Change
Set Pulumi.Type Aws Native. Cloud Formation. Change Set Type - The type of change set operation.
- Deployment
Mode Pulumi.Aws Native. Cloud Formation. Change Set Deployment Mode - Determines how CloudFormation handles configuration drift during deployment.
- Description string
- A description to help you identify this change set.
- Import
Existing boolResources - Indicates if the change set imports resources that already exist.
- Include
Nested boolStacks - 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 Pulumi.Failure Aws Native. Cloud Formation. Change Set On Stack Failure - 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.
-
List<Pulumi.
Aws Native. Inputs. Create Only Tag> - 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 boolTemplate - 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
[]Change
Set Capabilities Item - The capabilities that are allowed in the stack.
- Change
Set stringName - The name of the change set. Must be unique among all change sets associated with the specified stack.
- Change
Set ChangeType Set Type - The type of change set operation.
- Deployment
Mode ChangeSet Deployment Mode - Determines how CloudFormation handles configuration drift during deployment.
- Description string
- A description to help you identify this change set.
- Import
Existing boolResources - Indicates if the change set imports resources that already exist.
- Include
Nested boolStacks - Creates a change set for all nested stacks specified in the template.
- Notification
Arns []string - The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
- On
Stack ChangeFailure Set On Stack Failure - 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.
-
Create
Only Tag Args - 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 boolTemplate - 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_ stringname - The name of the change set. Must be unique among all change sets associated with the specified stack.
- change_
set_ "CREATE" | "UPDATE" | "IMPORT"type - 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_ boolresources - Indicates if the change set imports resources that already exist.
- include_
nested_ boolstacks - 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_ "DO_NOTHING" | "ROLLBACK" | "DELETE"failure - 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.
- 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_ booltemplate - 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<Change
Set Capabilities Item> - The capabilities that are allowed in the stack.
- change
Set StringName - The name of the change set. Must be unique among all change sets associated with the specified stack.
- change
Set ChangeType Set Type - The type of change set operation.
- deployment
Mode ChangeSet Deployment Mode - Determines how CloudFormation handles configuration drift during deployment.
- description String
- A description to help you identify this change set.
- import
Existing BooleanResources - Indicates if the change set imports resources that already exist.
- include
Nested BooleanStacks - 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 ChangeFailure Set On Stack Failure - 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.
-
List<Create
Only Tag> - 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 BooleanTemplate - 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
Change
Set Capabilities Item[] - The capabilities that are allowed in the stack.
- change
Set stringName - The name of the change set. Must be unique among all change sets associated with the specified stack.
- change
Set ChangeType Set Type - The type of change set operation.
- deployment
Mode ChangeSet Deployment Mode - Determines how CloudFormation handles configuration drift during deployment.
- description string
- A description to help you identify this change set.
- import
Existing booleanResources - Indicates if the change set imports resources that already exist.
- include
Nested booleanStacks - Creates a change set for all nested stacks specified in the template.
- notification
Arns string[] - The ARNs of Amazon SNS topics that CloudFormation associates with the stack.
- on
Stack ChangeFailure Set On Stack Failure - 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.
-
Create
Only Tag[] - 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 booleanTemplate - 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[Change
Set Capabilities Item] - The capabilities that are allowed in the stack.
- change_
set_ strname - The name of the change set. Must be unique among all change sets associated with the specified stack.
- change_
set_ Changetype Set Type - The type of change set operation.
- deployment_
mode ChangeSet Deployment Mode - Determines how CloudFormation handles configuration drift during deployment.
- description str
- A description to help you identify this change set.
- import_
existing_ boolresources - Indicates if the change set imports resources that already exist.
- include_
nested_ boolstacks - 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_ Changefailure Set On Stack Failure - 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.
-
Sequence[Create
Only Tag Args] - 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_ booltemplate - 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 StringName - The name of the change set. Must be unique among all change sets associated with the specified stack.
- change
Set "CREATE" | "UPDATE" | "IMPORT"Type - 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 BooleanResources - Indicates if the change set imports resources that already exist.
- include
Nested BooleanStacks - 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 "DO_NOTHING" | "ROLLBACK" | "DELETE"Failure - 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.
- List<Property Map>
- 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 BooleanTemplate - 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:
- Change
Set stringId - 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.
- Change
Set stringId - 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.
- change_
set_ stringid - 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.
- change
Set StringId - 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.
- change
Set stringId - 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.
- change_
set_ strid - 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.
- change
Set StringId - 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.
Supporting Types
ChangeSetCapabilitiesItem, ChangeSetCapabilitiesItemArgs
- Capability
Iam CAPABILITY_IAM- Capability
Named Iam CAPABILITY_NAMED_IAM- Capability
Auto Expand CAPABILITY_AUTO_EXPAND
- Change
Set Capabilities Item Capability Iam CAPABILITY_IAM- Change
Set Capabilities Item Capability Named Iam CAPABILITY_NAMED_IAM- Change
Set Capabilities Item Capability Auto Expand 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
- 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
- "CAPABILITY_IAM"
CAPABILITY_IAM- "CAPABILITY_NAMED_IAM"
CAPABILITY_NAMED_IAM- "CAPABILITY_AUTO_EXPAND"
CAPABILITY_AUTO_EXPAND
ChangeSetDeploymentMode, ChangeSetDeploymentModeArgs
- Revert
Drift REVERT_DRIFT
- Change
Set Deployment Mode Revert Drift REVERT_DRIFT
- "REVERT_DRIFT"
REVERT_DRIFT
- Revert
Drift REVERT_DRIFT
- Revert
Drift REVERT_DRIFT
- REVERT_DRIFT
REVERT_DRIFT
- "REVERT_DRIFT"
REVERT_DRIFT
ChangeSetOnStackFailure, ChangeSetOnStackFailureArgs
- Do
Nothing DO_NOTHING- Rollback
ROLLBACK- Delete
DELETE
- Change
Set On Stack Failure Do Nothing DO_NOTHING- Change
Set On Stack Failure Rollback ROLLBACK- Change
Set On Stack Failure Delete DELETE
- "DO_NOTHING"
DO_NOTHING- "ROLLBACK"
ROLLBACK- "DELETE"
DELETE
- Do
Nothing DO_NOTHING- Rollback
ROLLBACK- Delete
DELETE
- Do
Nothing 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
- Change
Set Type Create CREATE- Change
Set Type Update UPDATE- Change
Set Type 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
- "CREATE"
CREATE- "UPDATE"
UPDATE- "IMPORT"
IMPORT
CreateOnlyTag, CreateOnlyTagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi