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.
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 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.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#change_set_id ⇒ String
The unique ID of the change set.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#creation_time ⇒ Time
The time at which the stack was created.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#deletion_time ⇒ Time
The time the stack was deleted.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#description ⇒ String
A user-defined description associated with the stack.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#disable_rollback ⇒ Boolean
Boolean to enable or disable rollback on stack creation failures:
-
‘true`: disable rollback
-
‘false`: enable rollback
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#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].
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) 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 cannot be changed directly on the nested stack. For more information, see [Protecting a Stack From Being Deleted] in the *AWS 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
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) 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.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#notification_arns ⇒ Array<String>
SNS topic ARNs to which stack related events are published.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#outputs ⇒ Array<Types::Output>
A list of output structures.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#parameters ⇒ Array<Types::Parameter>
A list of ‘Parameter` structures.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) 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 *AWS CloudFormation User Guide*.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#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.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) 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.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#root_id ⇒ String
For nested stacks–stacks created as resources for another stack–the stack ID of the 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*.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#stack_id ⇒ String
Unique identifier of the stack.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#stack_name ⇒ String
The name associated with the stack.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#stack_status ⇒ String
Current status of the stack.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#stack_status_reason ⇒ String
Success/failure message associated with the stack status.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of ‘Tag`s that specify information about the stack.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |
#timeout_in_minutes ⇒ Integer
The amount of time within which stack creation should complete.
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3973 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) include Aws::Structure end |