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

Inherits:

Struct

Object
Struct
Aws::CloudFormation::Types::CreateStackSetInput

show all

Defined in:: gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#administration_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
#auto_deployment ⇒ Types::AutoDeployment
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU).
#call_as ⇒ String
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
#capabilities ⇒ Array<String>
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.
#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.
#managed_execution ⇒ Types::ManagedExecution
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
#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_id ⇒ String
The stack ID you are importing into a new stack set.
#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 URL of a file that contains the template body.

Instance Attribute Details

#administration_role_arn ⇒ `String`

The Amazon Resource Name (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 Grant self-managed permissions in the CloudFormation User Guide.

Valid only if the permissions model is SELF_MANAGED.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#auto_deployment ⇒ `Types::AutoDeployment`

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). For more information, see Manage automatic deployments for CloudFormation StackSets that use service-managed permissions in the CloudFormation User Guide.

Required if the permissions model is SERVICE_MANAGED. (Not used with self-managed permissions.)

Returns:

(Types::AutoDeployment)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#call_as ⇒ `String`

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

Valid only if the permissions model is SERVICE_MANAGED.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

class CreateStackSetInput < Struct.new(
  :stack_set_name,
  :description,
  :template_body,
  :template_url,
  :stack_id,
  :parameters,
  :capabilities,
  :tags,
  :administration_role_arn,
  :execution_role_name,
  :permission_model,
  :auto_deployment,
  :call_as,
  :client_request_token,
  :managed_execution)
  SENSITIVE = []
  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 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 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
- AWS::IAM::Group
- AWS::IAM::InstanceProfile
- AWS::IAM::Policy
- AWS::IAM::Role
- AWS::IAM::User
- AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM resources in 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 Perform custom processing on CloudFormation templates with template macros.

Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless 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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

Valid only if the permissions model is SELF_MANAGED.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#managed_execution ⇒ `Types::ManagedExecution`

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

Returns:

(Types::ManagedExecution)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#parameters ⇒ `Array<Types::Parameter>`

The input parameters for the stack set template.

Returns:

(Array<Types::Parameter>)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#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 permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for stack sets with Organizations.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#stack_id ⇒ `String`

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

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)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#tags ⇒ `Array<Types::Tag>`

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.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

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

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

#template_url ⇒ `String`

The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.

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

Returns:

(String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1841

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#administration_role_arn ⇒ String

#auto_deployment ⇒ Types::AutoDeployment

#call_as ⇒ String

#capabilities ⇒ Array<String>

#client_request_token ⇒ String

#description ⇒ String

#execution_role_name ⇒ String

#managed_execution ⇒ Types::ManagedExecution

#parameters ⇒ Array<Types::Parameter>

#permission_model ⇒ String

#stack_id ⇒ String

#stack_set_name ⇒ String

#tags ⇒ Array<Types::Tag>

#template_body ⇒ String

#template_url ⇒ String

#administration_role_arn ⇒ `String`

#auto_deployment ⇒ `Types::AutoDeployment`

#call_as ⇒ `String`

#capabilities ⇒ `Array<String>`

#client_request_token ⇒ `String`

#description ⇒ `String`

#execution_role_name ⇒ `String`

#managed_execution ⇒ `Types::ManagedExecution`

#parameters ⇒ `Array<Types::Parameter>`

#permission_model ⇒ `String`

#stack_id ⇒ `String`

#stack_set_name ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#template_body ⇒ `String`

#template_url ⇒ `String`