AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateChangeSetAsync.

Namespace: Amazon.CloudFormation
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C#
public virtual CreateChangeSetResponse CreateChangeSet(
         CreateChangeSetRequest request
)

Parameters

request
Type: Amazon.CloudFormation.Model.CreateChangeSetRequest

Container for the necessary parameters to execute the CreateChangeSet service method.

Return Value


The response from the CreateChangeSet service method, as returned by CloudFormation.

Exceptions

ExceptionCondition
AlreadyExistsException The resource with the name requested already exists.
InsufficientCapabilitiesException The template contains resources with capabilities that weren't specified in the Capabilities parameter.
LimitExceededException The quota for the resource has already been reached. For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also