You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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,
    },
  ],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set 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 their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:

  • AWS::IAM::AccessKey

  • AWS::IAM::Group

  • AWS::IAM::InstanceProfile

  • AWS::IAM::Policy

  • AWS::IAM::Role

  • AWS::IAM::User

  • AWS::IAM::UserToGroupAddition

If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Returns:

  • (Array<String>)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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

#client_request_tokenString

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)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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

#descriptionString

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

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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

#parametersArray<Types::Parameter>

The input parameters for the stack set template.

Returns:



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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

#stack_set_nameString

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

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.

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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

#tagsArray<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:



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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

#template_bodyString

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.

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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

#template_urlString

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.

Returns:

  • (String)


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1021

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