You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Types::CreateStackSetInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::CreateStackSetInput
- Defined in:
- (unknown)
Overview
When passing CreateStackSetInput as input to an Aws::Client method, you can use a vanilla 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,
},
client_request_token: "ClientRequestToken",
}
Instance Attribute Summary collapse
-
#administration_role_arn ⇒ String
The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
-
#auto_deployment ⇒ Types::AutoDeployment
Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU).
-
#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.
-
#client_request_token ⇒ String
A unique identifier for this
CreateStackSet
request. -
#description ⇒ String
A description of the stack set.
-
#execution_role_name ⇒ String
The name of the IAM execution role to use to create the stack set.
-
#parameters ⇒ Array<Types::Parameter>
The input parameters for the stack set template.
-
#permission_model ⇒ String
Describes how the IAM roles required for stack set operations are created.
-
#stack_set_name ⇒ String
The name to associate with the stack set.
-
#tags ⇒ Array<Types::Tag>
The key-value pairs to associate with this stack set and the stacks created from it.
-
#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.
-
#template_url ⇒ String
The location of the file that contains the template body.
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.
#auto_deployment ⇒ Types::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
.
#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
andCAPABILITY_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
orCAPABILITY_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 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.
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.
#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.
#description ⇒ String
A description of the stack set. You can use the description to identify the stack set\'s purpose or other important information.
#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.
#parameters ⇒ Array<Types::Parameter>
The input parameters for the stack set template.
#permission_model ⇒ String
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.
#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.
#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.
#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.
#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.