AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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,
      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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#administration_role_arnString

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.

Returns:

  • (String)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deploymentTypes::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.



1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#call_asString

[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 AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

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

Returns:

  • (String)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#capabilitiesArray<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.

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

  • 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 AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS 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.

Returns:

  • (Array<String>)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  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)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  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)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_nameString

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)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#parametersArray<Types::Parameter>

The input parameters for the stack set template.

Returns:



1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#permission_modelString

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

Returns:

  • (String)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  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)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  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:



1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  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)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  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 or a Systems Manager document. 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)


1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1749

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end