class Aws::CloudFormation::Types::CreateStackSetInput

@note When making an API call, you may pass CreateStackSetInput

data as a hash:

    {
      stack_set_name: "StackSetName", # required
      description: "Description",
      template_body: "TemplateBody",
      template_url: "TemplateURL",
      stack_id: "StackId",
      parameters: [
        {
          parameter_key: "ParameterKey",
          parameter_value: "ParameterValue",
          use_previous_value: false,
          resolved_value: "ParameterValue",
        },
      ],
      capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      administration_role_arn: "RoleARN",
      execution_role_name: "ExecutionRoleName",
      permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
      auto_deployment: {
        enabled: false,
        retain_stacks_on_account_removal: false,
      },
      call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
      client_request_token: "ClientRequestToken",
      managed_execution: {
        active: false,
      },
    }

@!attribute [rw] stack_set_name

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

<note markdown="1"> A stack name can contain only alphanumeric characters
(case-sensitive) and hyphens. It must start with an alphabetic
character and can't be longer than 128 characters.

 </note>
@return [String]

@!attribute [rw] description

A description of the stack set. You can use the description to
identify the stack set's purpose or other important information.
@return [String]

@!attribute [rw] template_body

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][1] in the CloudFormation User
Guide.

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

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
@return [String]

@!attribute [rw] template_url

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 or a Systems Manager document. For
more information, see [Template Anatomy][1] in the CloudFormation
User Guide.

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

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
@return [String]

@!attribute [rw] stack_id

The stack ID you are importing into a new stack set. Specify the
Amazon Resource Number (ARN) of the stack.
@return [String]

@!attribute [rw] parameters

The input parameters for the stack set template.
@return [Array<Types::Parameter>]

@!attribute [rw] capabilities

In some cases, you must explicitly acknowledge that your stack set
template contains certain capabilities in order for 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 Amazon Web Services account; for example, by
  creating new 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,
    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][1]

  * [ AWS::IAM::Group][2]

  * [AWS::IAM::InstanceProfile][3]

  * [ AWS::IAM::Policy][4]

  * [ AWS::IAM::Role][5]

  * [ AWS::IAM::User][6]

  * [AWS::IAM::UserToGroupAddition][7]

  For more information, see [Acknowledging IAM Resources in
  CloudFormation Templates][8].

* `CAPABILITY_AUTO_EXPAND`

  Some templates reference macros. If your stack set template
  references one or more macros, you must create the stack set
  directly from the processed template, without first reviewing the
  resulting changes in a change set. To create the stack set
  directly, you must acknowledge this capability. For more
  information, see [Using CloudFormation Macros to Perform Custom
  Processing on Templates][9].

  Stack sets with service-managed permissions don't currently
  support the use of macros in templates. (This includes the
  [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
  macros hosted by CloudFormation.) Even if you specify this
  capability for a stack set with service-managed permissions, if
  you reference a macro in your template the stack set operation
  will fail.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
[3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
[4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
[5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
[6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
[7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
[8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
[9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
[10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
[11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
@return [Array<String>]

@!attribute [rw] tags

The key-value pairs to associate with this stack set and the stacks
created from it. 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,
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.
@return [Array<Types::Tag>]

@!attribute [rw] administration_role_arn

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][1] in the *CloudFormation User Guide*.

[1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
@return [String]

@!attribute [rw] execution_role_name

The name of the IAM execution role to use to create the stack set.
If you do not specify an execution role, 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.
@return [String]

@!attribute [rw] permission_model

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][1].

* With `service-managed` permissions, StackSets automatically
  creates the IAM roles required to deploy to accounts managed by
  Organizations. For more information, see [Grant Service-Managed
  Stack Set Permissions][2].

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
@return [String]

@!attribute [rw] auto_deployment

Describes whether StackSets automatically deploys to Organizations
accounts that are added to the target organization or organizational
unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
@return [Types::AutoDeployment]

@!attribute [rw] call_as

\[Service-managed permissions\] Specifies whether you are acting as
an account administrator in the organization's management account
or as a delegated administrator in a member account.

By default, `SELF` is specified. Use `SELF` for stack sets with
self-managed permissions.

* To create a stack set with service-managed permissions while
  signed in to the management account, specify `SELF`.

* To create a stack set with service-managed permissions while
  signed in to a delegated administrator account, specify
  `DELEGATED_ADMIN`.

  Your Amazon Web Services account must be registered as a delegated
  admin in the management account. For more information, see
  [Register a delegated administrator][1] in the *CloudFormation
  User Guide*.

Stack sets with service-managed permissions are created in the
management account, including stack sets that are created by
delegated administrators.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
@return [String]

@!attribute [rw] client_request_token

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

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

**A suitable default value is auto-generated.** You should normally
not need to pass this option.
@return [String]

@!attribute [rw] managed_execution

Describes whether StackSets performs non-conflicting operations
concurrently and queues conflicting operations.
@return [Types::ManagedExecution]

@see docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSetInput AWS API Documentation

Constants

SENSITIVE