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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass CreateStackInput data as a hash:

{
  stack_name: "StackName", # required
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  disable_rollback: false,
  rollback_configuration: {
    rollback_triggers: [
      {
        arn: "Arn", # required
        type: "Type", # required
      },
    ],
    monitoring_time_in_minutes: 1,
  },
  timeout_in_minutes: 1,
  notification_arns: ["NotificationARN"],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  resource_types: ["ResourceType"],
  role_arn: "RoleARN",
  on_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
  stack_policy_body: "StackPolicyBody",
  stack_policy_url: "StackPolicyURL",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
  enable_termination_protection: false,
}

The input for CreateStack action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#capabilities ⇒ Array<String>

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

  • ‘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 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, 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.

    • AWS::IAM::AccessKey][1
    • AWS::IAM::Group][2
    • AWS::IAM::InstanceProfile][3
    • AWS::IAM::Policy][4
    • AWS::IAM::Role][5
    • AWS::IAM::User][6
    • AWS::IAM::UserToGroupAddition][7

    For more information, see [Acknowledging IAM Resources in AWS 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 AWS CloudFormation.

    Change sets do not currently support nested stacks. 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 AWS CloudFormation being notified.

    For more information, see [Using AWS CloudFormation Macros to Perform Custom Processing on Templates].

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html [3]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html [4]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html [5]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html [6]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html [7]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html [8]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities [9]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html [10]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html [11]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html

Returns:

  • (Array<String>) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  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 AWS CloudFormation knows that you’re not attempting to create a stack with the same name. You might retry ‘CreateStack` requests to ensure that AWS CloudFormation successfully received them.

All events triggered 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) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  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 [Protecting a Stack From Being Deleted] in the *AWS CloudFormation User Guide*. Termination protection is disabled on stacks by default.

For [nested stacks], termination protection is set on the root stack and cannot be changed directly on the nested stack.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html

Returns:

  • (Boolean) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  include Aws::Structure
end

#notification_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html

Returns:



938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  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 AWS resource), `Custom::*` (for all custom resources), `Custom::logical_ID ` (for a specific custom resource), `AWS::service_name::*` (for all resources of a particular AWS service), and `AWS::service_name::resource_logical_ID ` (for a specific AWS resource).

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html

Returns:

  • (Array<String>) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role’s credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS 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, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Returns:

  • (String) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  include Aws::Structure
end

#rollback_configuration ⇒ Types::RollbackConfiguration

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

Returns:



938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  include Aws::Structure
end

#stack_name ⇒ String

The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

<note markdown=“1”> A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.

</note>

Returns:

  • (String) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  include Aws::Structure
end

#stack_policy_body ⇒ String

Structure containing the stack policy body. For more information, go to [ Prevent Updates to Stack Resources] in the *AWS CloudFormation User Guide*. You can specify either the ‘StackPolicyBody` or the `StackPolicyURL` parameter, but not both.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html

Returns:

  • (String) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  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. You can specify either the ‘StackPolicyBody` or the `StackPolicyURL` parameter, but not both.

Returns:

  • (String) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  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. For more information, go to [Template Anatomy] in the AWS CloudFormation User Guide.

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html

Returns:

  • (String) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  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 is located in an Amazon S3 bucket. For more information, go to the [Template Anatomy] in the AWS CloudFormation User Guide.

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html

Returns:

  • (String) 


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 938

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)
  include Aws::Structure
end