createChangeSet method

Future<CreateChangeSetOutput> createChangeSet({ required String changeSetName, required String stackName, List<Capability>? capabilities, ChangeSetType? changeSetType, String? clientToken, String? description, bool? includeNestedStacks, List<String>? notificationARNs, List<Parameter>? parameters, List<String>? resourceTypes, List<ResourceToImport>? resourcesToImport, String? roleARN, RollbackConfiguration? rollbackConfiguration, List<Tag>? tags, String? templateBody, String? templateURL, bool? usePreviousTemplate, })

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 AWS CloudFormation will create. If you create a change set for an existing stack, AWS 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 AWS 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, AWS 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. AWS CloudFormation doesn't make changes until you execute the change set.

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

May throw AlreadyExistsException. May throw InsufficientCapabilitiesException. May throw LimitExceededException.

Parameter changeSetName : The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Parameter stackName : The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Parameter capabilities : In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.

• CAPABILITY_IAM and CAPABILITY_NAMED_IAM

  Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

  • If you have IAM resources, you can specify either capability.
  • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
  • If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
  If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
  • AWS::IAM::AccessKey
  • AWS::IAM::Group
  • AWS::IAM::InstanceProfile
  • AWS::IAM::Policy
  • AWS::IAM::Role
  • AWS::IAM::User
  • AWS::IAM::UserToGroupAddition
  For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
• CAPABILITY_AUTO_EXPAND

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

  If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability. For more information on macros, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

Parameter changeSetType : The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

Parameter clientToken : A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.

Parameter description : A description to help you identify this change set.

Parameter includeNestedStacks : Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

Parameter notificationARNs : The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Parameter parameters : A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

Parameter resourceTypes : The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Parameter resourcesToImport : The resources to import into your stack.

Parameter roleARN : The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Parameter rollbackConfiguration : The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Parameter tags : Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Parameter templateBody : A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Parameter templateURL : The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Parameter usePreviousTemplate : Whether to reuse the template that is associated with the stack to create the change set.

Implementation

Future<CreateChangeSetOutput> createChangeSet({
  required String changeSetName,
  required String stackName,
  List<Capability>? capabilities,
  ChangeSetType? changeSetType,
  String? clientToken,
  String? description,
  bool? includeNestedStacks,
  List<String>? notificationARNs,
  List<Parameter>? parameters,
  List<String>? resourceTypes,
  List<ResourceToImport>? resourcesToImport,
  String? roleARN,
  RollbackConfiguration? rollbackConfiguration,
  List<Tag>? tags,
  String? templateBody,
  String? templateURL,
  bool? usePreviousTemplate,
}) async {
  ArgumentError.checkNotNull(changeSetName, 'changeSetName');
  _s.validateStringLength(
    'changeSetName',
    changeSetName,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(stackName, 'stackName');
  _s.validateStringLength(
    'stackName',
    stackName,
    1,
    1152921504606846976,
    isRequired: true,
  );
  _s.validateStringLength(
    'clientToken',
    clientToken,
    1,
    128,
  );
  _s.validateStringLength(
    'description',
    description,
    1,
    1024,
  );
  _s.validateStringLength(
    'roleARN',
    roleARN,
    20,
    2048,
  );
  _s.validateStringLength(
    'templateBody',
    templateBody,
    1,
    1152921504606846976,
  );
  _s.validateStringLength(
    'templateURL',
    templateURL,
    1,
    1024,
  );
  final $request = <String, dynamic>{};
  $request['ChangeSetName'] = changeSetName;
  $request['StackName'] = stackName;
  capabilities?.also((arg) =>
      $request['Capabilities'] = arg.map((e) => e.toValue()).toList());
  changeSetType?.also((arg) => $request['ChangeSetType'] = arg.toValue());
  clientToken?.also((arg) => $request['ClientToken'] = arg);
  description?.also((arg) => $request['Description'] = arg);
  includeNestedStacks?.also((arg) => $request['IncludeNestedStacks'] = arg);
  notificationARNs?.also((arg) => $request['NotificationARNs'] = arg);
  parameters?.also((arg) => $request['Parameters'] = arg);
  resourceTypes?.also((arg) => $request['ResourceTypes'] = arg);
  resourcesToImport?.also((arg) => $request['ResourcesToImport'] = arg);
  roleARN?.also((arg) => $request['RoleARN'] = arg);
  rollbackConfiguration
      ?.also((arg) => $request['RollbackConfiguration'] = arg);
  tags?.also((arg) => $request['Tags'] = arg);
  templateBody?.also((arg) => $request['TemplateBody'] = arg);
  templateURL?.also((arg) => $request['TemplateURL'] = arg);
  usePreviousTemplate?.also((arg) => $request['UsePreviousTemplate'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CreateChangeSet',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateChangeSetInput'],
    shapes: shapes,
    resultWrapper: 'CreateChangeSetResult',
  );
  return CreateChangeSetOutput.fromXml($result);
}