createStackSet method

Future<CreateStackSetOutput> createStackSet({ required String stackSetName, String? administrationRoleARN, AutoDeployment? autoDeployment, List<Capability>? capabilities, String? clientRequestToken, String? description, String? executionRoleName, List<Parameter>? parameters, PermissionModels? permissionModel, List<Tag>? tags, String? templateBody, String? templateURL, })

Creates a stack set.

May throw NameAlreadyExistsException. May throw CreatedButModifiedException. May throw LimitExceededException.

Parameter stackSetName : The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

Parameter administrationRoleARN : The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Parameter autoDeployment : Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Parameter capabilities : In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create 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 clientRequestToken : A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Parameter description : A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Parameter executionRoleName : The name of the IAM execution role to use to create 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.

Parameter parameters : The input parameters for the stack set template.

Parameter permissionModel : Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

• 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 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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

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 either the TemplateBody or the TemplateURL parameter, but not both.

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's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Implementation

Future<CreateStackSetOutput> createStackSet({
  required String stackSetName,
  String? administrationRoleARN,
  AutoDeployment? autoDeployment,
  List<Capability>? capabilities,
  String? clientRequestToken,
  String? description,
  String? executionRoleName,
  List<Parameter>? parameters,
  PermissionModels? permissionModel,
  List<Tag>? tags,
  String? templateBody,
  String? templateURL,
}) async {
  ArgumentError.checkNotNull(stackSetName, 'stackSetName');
  _s.validateStringLength(
    'administrationRoleARN',
    administrationRoleARN,
    20,
    2048,
  );
  _s.validateStringLength(
    'clientRequestToken',
    clientRequestToken,
    1,
    128,
  );
  _s.validateStringLength(
    'description',
    description,
    1,
    1024,
  );
  _s.validateStringLength(
    'executionRoleName',
    executionRoleName,
    1,
    64,
  );
  _s.validateStringLength(
    'templateBody',
    templateBody,
    1,
    1152921504606846976,
  );
  _s.validateStringLength(
    'templateURL',
    templateURL,
    1,
    1024,
  );
  final $request = <String, dynamic>{};
  $request['StackSetName'] = stackSetName;
  administrationRoleARN
      ?.also((arg) => $request['AdministrationRoleARN'] = arg);
  autoDeployment?.also((arg) => $request['AutoDeployment'] = arg);
  capabilities?.also((arg) =>
      $request['Capabilities'] = arg.map((e) => e.toValue()).toList());
  $request['ClientRequestToken'] =
      clientRequestToken ?? _s.generateIdempotencyToken();
  description?.also((arg) => $request['Description'] = arg);
  executionRoleName?.also((arg) => $request['ExecutionRoleName'] = arg);
  parameters?.also((arg) => $request['Parameters'] = arg);
  permissionModel?.also((arg) => $request['PermissionModel'] = arg.toValue());
  tags?.also((arg) => $request['Tags'] = arg);
  templateBody?.also((arg) => $request['TemplateBody'] = arg);
  templateURL?.also((arg) => $request['TemplateURL'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CreateStackSet',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateStackSetInput'],
    shapes: shapes,
    resultWrapper: 'CreateStackSetResult',
  );
  return CreateStackSetOutput.fromXml($result);
}