updateStackSet method

Future<UpdateStackSetOutput> updateStackSet({ required String stackSetName, List<String>? accounts, String? administrationRoleARN, AutoDeployment? autoDeployment, List<Capability>? capabilities, DeploymentTargets? deploymentTargets, String? description, String? executionRoleName, String? operationId, StackSetOperationPreferences? operationPreferences, List<Parameter>? parameters, PermissionModels? permissionModel, List<String>? regions, List<Tag>? tags, String? templateBody, String? templateURL, bool? usePreviousTemplate, })

Updates the stack set, and associated stack instances in the specified accounts and Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

May throw StackSetNotFoundException. May throw OperationInProgressException. May throw OperationIdAlreadyExistsException. May throw StaleRequestException. May throw InvalidOperationException. May throw StackInstanceNotFoundException.

Parameter stackSetName : The name or unique ID of the stack set that you want to update.

Parameter accounts : <code>Self-managed</code> permissions The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Parameter administrationRoleARN : The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Parameter autoDeployment : <code>Service-managed</code> permissions Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

Parameter capabilities : In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

• 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 sets, 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 templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

Parameter deploymentTargets : <code>Service-managed</code> permissions The AWS Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Parameter description : A brief description of updates that you are making.

Parameter executionRoleName : The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Parameter operationId : The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Parameter operationPreferences : Preferences for how AWS CloudFormation performs this stack set operation.

Parameter parameters : A list of input parameters for the stack set template.

Parameter permissionModel : Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

Parameter regions : The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Parameter tags : The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

• If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
• If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
• If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Parameter templateBody : The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

Parameter templateURL : The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

Parameter usePreviousTemplate : Use the existing template that's associated with the stack set that you're updating.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

Implementation

Future<UpdateStackSetOutput> updateStackSet({
  required String stackSetName,
  List<String>? accounts,
  String? administrationRoleARN,
  AutoDeployment? autoDeployment,
  List<Capability>? capabilities,
  DeploymentTargets? deploymentTargets,
  String? description,
  String? executionRoleName,
  String? operationId,
  StackSetOperationPreferences? operationPreferences,
  List<Parameter>? parameters,
  PermissionModels? permissionModel,
  List<String>? regions,
  List<Tag>? tags,
  String? templateBody,
  String? templateURL,
  bool? usePreviousTemplate,
}) async {
  ArgumentError.checkNotNull(stackSetName, 'stackSetName');
  _s.validateStringLength(
    'administrationRoleARN',
    administrationRoleARN,
    20,
    2048,
  );
  _s.validateStringLength(
    'description',
    description,
    1,
    1024,
  );
  _s.validateStringLength(
    'executionRoleName',
    executionRoleName,
    1,
    64,
  );
  _s.validateStringLength(
    'operationId',
    operationId,
    1,
    128,
  );
  _s.validateStringLength(
    'templateBody',
    templateBody,
    1,
    1152921504606846976,
  );
  _s.validateStringLength(
    'templateURL',
    templateURL,
    1,
    1024,
  );
  final $request = <String, dynamic>{};
  $request['StackSetName'] = stackSetName;
  accounts?.also((arg) => $request['Accounts'] = arg);
  administrationRoleARN
      ?.also((arg) => $request['AdministrationRoleARN'] = arg);
  autoDeployment?.also((arg) => $request['AutoDeployment'] = arg);
  capabilities?.also((arg) =>
      $request['Capabilities'] = arg.map((e) => e.toValue()).toList());
  deploymentTargets?.also((arg) => $request['DeploymentTargets'] = arg);
  description?.also((arg) => $request['Description'] = arg);
  executionRoleName?.also((arg) => $request['ExecutionRoleName'] = arg);
  $request['OperationId'] = operationId ?? _s.generateIdempotencyToken();
  operationPreferences?.also((arg) => $request['OperationPreferences'] = arg);
  parameters?.also((arg) => $request['Parameters'] = arg);
  permissionModel?.also((arg) => $request['PermissionModel'] = arg.toValue());
  regions?.also((arg) => $request['Regions'] = 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: 'UpdateStackSet',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['UpdateStackSetInput'],
    shapes: shapes,
    resultWrapper: 'UpdateStackSetResult',
  );
  return UpdateStackSetOutput.fromXml($result);
}