You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Types::Stack
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::Stack
- Defined in:
- (unknown)
Overview
The Stack data type.
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 on 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>
SNS topic 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 AWS Identity and Access Management (IAM) role that is associated with the stack.
-
#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.
-
#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.
#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:
true
: disable rollbackfalse
: enable rollback
#drift_information ⇒ Types::StackDriftInformation
Information on 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.
#enable_termination_protection ⇒ Boolean
Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
#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.
#notification_arns ⇒ Array<String>
SNS topic 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. 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 AWS CloudFormation User Guide.
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role\'s credentials to make calls on your behalf.
#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.
#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 AWS CloudFormation User Guide.
#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.
Possible values:
- CREATE_IN_PROGRESS
- CREATE_FAILED
- CREATE_COMPLETE
- ROLLBACK_IN_PROGRESS
- ROLLBACK_FAILED
- ROLLBACK_COMPLETE
- DELETE_IN_PROGRESS
- DELETE_FAILED
- DELETE_COMPLETE
- UPDATE_IN_PROGRESS
- UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- UPDATE_COMPLETE
- UPDATE_ROLLBACK_IN_PROGRESS
- UPDATE_ROLLBACK_FAILED
- UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- UPDATE_ROLLBACK_COMPLETE
- REVIEW_IN_PROGRESS
- IMPORT_IN_PROGRESS
- IMPORT_COMPLETE
- IMPORT_ROLLBACK_IN_PROGRESS
- IMPORT_ROLLBACK_FAILED
- IMPORT_ROLLBACK_COMPLETE
#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.