Class: Aws::CloudFormation::Types::CreateStackInput

Inherits:

Struct

Object
Struct
Aws::CloudFormation::Types::CreateStackInput

show all

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

Overview

The input for CreateStack action.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#capabilities ⇒ Array<String>
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
#client_request_token ⇒ String
A unique identifier for this CreateStack request.
#disable_rollback ⇒ Boolean
Set to true to disable rollback of the stack if stack creation failed.
#enable_termination_protection ⇒ Boolean
Whether to enable termination protection on the specified stack.
#notification_arns ⇒ Array<String>
The Amazon SNS topic ARNs to publish stack related events.
#on_failure ⇒ String
Determines what action will be taken if stack creation fails.
#parameters ⇒ Array<Types::Parameter>
A list of Parameter structures that specify input parameters for the stack.
#resource_types ⇒ Array<String>
The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
#retain_except_on_create ⇒ Boolean
When set to true, newly created resources are deleted when the operation rolls back.
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the stack.
#rollback_configuration ⇒ Types::RollbackConfiguration
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
#stack_name ⇒ String
The name that's associated with the stack.
#stack_policy_body ⇒ String
Structure containing the stack policy body.
#stack_policy_url ⇒ String
Location of a file containing the stack policy.
#tags ⇒ Array<Types::Tag>
Key-value pairs to associate with this stack.
#template_body ⇒ String
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
#template_url ⇒ String
Location of file containing the template body.
#timeout_in_minutes ⇒ Integer
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Instance Attribute Details

#capabilities ⇒ `Array<String>`

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

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 stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. 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. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.

Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

For more information, see Perform custom processing on CloudFormation templates with template macros.

Only one of the Capabilities and ResourceType parameters can be specified.

Returns:

(Array<String>)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ `String`

A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that CloudFormation successfully received them.

All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

Returns:

(String)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#disable_rollback ⇒ `Boolean`

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

Default: false

Returns:

(Boolean)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#enable_termination_protection ⇒ `Boolean`

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect CloudFormation stacks from being deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.

Returns:

(Boolean)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#notification_arns ⇒ `Array<String>`

The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

Returns:

(Array<String>)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#on_failure ⇒ `String`

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Returns:

(String)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

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

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

Returns:

(Array<Types::Parameter>)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#resource_types ⇒ `Array<String>`

The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web Services resource).

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management.

Only one of the Capabilities and ResourceType parameters can be specified.

Returns:

(Array<String>)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#retain_except_on_create ⇒ `Boolean`

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

Returns:

(Boolean)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

Returns:

(String)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_configuration ⇒ `Types::RollbackConfiguration`

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Returns:

(Types::RollbackConfiguration)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ `String`

The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.

Returns:

(String)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#stack_policy_body ⇒ `String`

Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Returns:

(String)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#stack_policy_url ⇒ `String`

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Returns:

(String)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

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

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

Returns:

(Array<Types::Tag>)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#template_body ⇒ `String`

Structure containing 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 1372

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#template_url ⇒ `String`

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) 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 1372

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_minutes ⇒ `Integer`

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Returns:

(Integer)

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

class CreateStackInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :parameters,
  :disable_rollback,
  :rollback_configuration,
  :timeout_in_minutes,
  :notification_arns,
  :capabilities,
  :resource_types,
  :role_arn,
  :on_failure,
  :stack_policy_body,
  :stack_policy_url,
  :tags,
  :client_request_token,
  :enable_termination_protection,
  :retain_except_on_create)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CloudFormation::Types::CreateStackInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#capabilities ⇒ Array<String>

#client_request_token ⇒ String

#disable_rollback ⇒ Boolean

#enable_termination_protection ⇒ Boolean

#notification_arns ⇒ Array<String>

#on_failure ⇒ String

#parameters ⇒ Array<Types::Parameter>

#resource_types ⇒ Array<String>

#retain_except_on_create ⇒ Boolean

#role_arn ⇒ String

#rollback_configuration ⇒ Types::RollbackConfiguration

#stack_name ⇒ String

#stack_policy_body ⇒ String

#stack_policy_url ⇒ String

#tags ⇒ Array<Types::Tag>

#template_body ⇒ String

#template_url ⇒ String

#timeout_in_minutes ⇒ Integer

#capabilities ⇒ `Array<String>`

#client_request_token ⇒ `String`

#disable_rollback ⇒ `Boolean`

#enable_termination_protection ⇒ `Boolean`

#notification_arns ⇒ `Array<String>`

#on_failure ⇒ `String`

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

#resource_types ⇒ `Array<String>`

#retain_except_on_create ⇒ `Boolean`

#role_arn ⇒ `String`

#rollback_configuration ⇒ `Types::RollbackConfiguration`

#stack_name ⇒ `String`

#stack_policy_body ⇒ `String`

#stack_policy_url ⇒ `String`

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

#template_body ⇒ `String`

#template_url ⇒ `String`

#timeout_in_minutes ⇒ `Integer`