Class: Aws::CloudFormation::Types::Stack
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::Stack
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudformation/types.rb
Overview
The Stack data type.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#capabilities ⇒ Array<String>
The capabilities allowed in the stack.
-
#change_set_id ⇒ String
The unique ID of the change set.
-
#creation_time ⇒ Time
The time at which the stack was created.
-
#deletion_time ⇒ Time
The time the stack was deleted.
-
#description ⇒ String
A user-defined description associated with the stack.
-
#disable_rollback ⇒ Boolean
Boolean to enable or disable rollback on stack creation failures:.
-
#drift_information ⇒ Types::StackDriftInformation
Information about whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters.
-
#enable_termination_protection ⇒ Boolean
Whether termination protection is enabled for the stack.
-
#last_updated_time ⇒ Time
The time the stack was last updated.
-
#notification_arns ⇒ Array<String>
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
-
#outputs ⇒ Array<Types::Output>
A list of output structures.
-
#parameters ⇒ Array<Types::Parameter>
A list of `Parameter` structures.
-
#parent_id ⇒ String
For nested stacks–stacks created as resources for another stack–the stack ID of the direct parent of this stack.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with 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.
-
#root_id ⇒ String
For nested stacks–stacks created as resources for another stack–the stack ID of the top-level stack to which the nested stack ultimately belongs.
-
#stack_id ⇒ String
Unique identifier of the stack.
-
#stack_name ⇒ String
The name associated with the stack.
-
#stack_status ⇒ String
Current status of the stack.
-
#stack_status_reason ⇒ String
Success/failure message associated with the stack status.
-
#tags ⇒ Array<Types::Tag>
A list of `Tag`s that specify information about the stack.
-
#timeout_in_minutes ⇒ Integer
The amount of time within which stack creation should complete.
Instance Attribute Details
#capabilities ⇒ Array<String>
The capabilities allowed in the stack.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#change_set_id ⇒ String
The unique ID of the change set.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#creation_time ⇒ Time
The time at which the stack was created.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#deletion_time ⇒ Time
The time the stack was deleted.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A user-defined description associated with the stack.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#disable_rollback ⇒ Boolean
Boolean to enable or disable rollback on stack creation failures:
-
`true`: disable rollback.
-
`false`: enable rollback.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#drift_information ⇒ Types::StackDriftInformation
Information about whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see [Detecting Unregulated Configuration Changes to Stacks and Resources].
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#enable_termination_protection ⇒ Boolean
Whether termination protection is enabled for the stack.
For [nested stacks], termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see [Protecting a Stack From Being Deleted] in the *CloudFormation User Guide*.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#last_updated_time ⇒ Time
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#notification_arns ⇒ Array<String>
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#outputs ⇒ Array<Types::Output>
A list of output structures.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#parameters ⇒ Array<Types::Parameter>
A list of `Parameter` structures.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#parent_id ⇒ String
For nested stacks–stacks created as resources for another stack–the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see [Working with Nested Stacks] in the *CloudFormation User Guide*.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) 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.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#root_id ⇒ String
For nested stacks–stacks created as resources for another stack–the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see [Working with Nested Stacks] in the *CloudFormation User Guide*.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#stack_id ⇒ String
Unique identifier of the stack.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#stack_name ⇒ String
The name associated with the stack.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#stack_status ⇒ String
Current status of the stack.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#stack_status_reason ⇒ String
Success/failure message associated with the stack status.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of `Tag`s that specify information about the stack.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |
#timeout_in_minutes ⇒ Integer
The amount of time within which stack creation should complete.
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6320 class Stack < Struct.new( :stack_id, :stack_name, :change_set_id, :description, :parameters, :creation_time, :deletion_time, :last_updated_time, :rollback_configuration, :stack_status, :stack_status_reason, :disable_rollback, :notification_arns, :timeout_in_minutes, :capabilities, :outputs, :role_arn, :tags, :enable_termination_protection, :parent_id, :root_id, :drift_information) SENSITIVE = [] include Aws::Structure end |