Class: Aws::CloudFormation::Types::CreateStackSetInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

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",
  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",
  client_request_token: "ClientRequestToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#administration_role_arn ⇒ String

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*.

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

Returns:

  • (String) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#capabilities ⇒ Array<String>

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

    <note markdown=“1”> Stack sets do not currently support macros in stack templates. (This includes the [AWS::Include] and [AWS::Serverless] transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.

    </note>

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

Returns:

  • (Array<String>) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#client_request_token ⇒ String

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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#description ⇒ String

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

Returns:

  • (String) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#execution_role_name ⇒ String

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.

Returns:

  • (String) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#parameters ⇒ Array<Types::Parameter>

The input parameters for the stack set template.

Returns:



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#stack_set_name ⇒ String

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>

Returns:

  • (String) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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.

Returns:



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#template_body ⇒ String

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.

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

Returns:

  • (String) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end

#template_url ⇒ String

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.

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

Returns:

  • (String) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1352

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :client_request_token)
  include Aws::Structure
end