You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Stack Instance Attribute Summary collapseThe capabilities allowed in the stack.
The unique ID of the change set.
The time at which the stack was created.
The time the stack was deleted.
A user-defined description associated with the stack.
Boolean to enable or disable rollback on stack creation failures:.
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.
Whether termination protection is enabled for the stack.
The time the stack was last updated.
SNS topic ARNs to which stack related events are published.
A list of output structures.
A list of Parameter
structures.
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack.
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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.
Unique identifier of the stack.
The name associated with the stack.
Current status of the stack.
Success/failure message associated with the stack status.
A list of Tag
s that specify information about the stack.
The amount of time within which stack creation should complete.
Cancels an update on the specified stack.
Creates a stack as specified in the template.
Deletes a specified stack.
Returns a Collection of Event resources.
Returns true
if this Stack exists.
Returns a Collection of StackResourceSummary resources.
Updates a stack as specified in the template.
Waits until this Stack is exists.
add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until
Methods included from Resources::OperationMethods#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations
Constructor Details #initialize(name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object Instance Attribute Details #capabilities ⇒ Array<String>The capabilities allowed in the stack.
#change_set_id ⇒ StringThe unique ID of the change set.
#creation_time ⇒ TimeThe time at which the stack was created.
#deletion_time ⇒ TimeThe time the stack was deleted.
#description ⇒ StringA user-defined description associated with the stack.
#disable_rollback ⇒ BooleanBoolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
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 ⇒ TimeThe 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.
#parent_id ⇒ StringFor 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 ⇒ StringThe 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::RollbackConfigurationThe rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
#root_id ⇒ StringFor 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 ⇒ StringUnique identifier of the stack.
#stack_name ⇒ StringThe name associated with the stack.
#stack_status ⇒ StringCurrent status of the stack.
Possible values:
Success/failure message associated with the stack status.
#tags ⇒ Array<Types::Tag>A list of Tag
s that specify information about the stack.
The amount of time within which stack creation should complete.
Instance Method Details #cancel_update(options = {}) ⇒ StructCancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
#create(options = {}) ⇒ Types::CreateStackOutputCreates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
#delete(options = {}) ⇒ StructDeletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
#events(options = {}) ⇒ Collection<Event> #exists? ⇒ BooleanReturns true
if this Stack exists. Returns false
otherwise.
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
#wait_until_exists {|waiter| ... } ⇒ StackWaits until this Stack is exists. This method waits by polling Client#describe_stacks until successful. An error is raised after a configurable number of failed checks.
This waiter uses the following defaults:
Configuration Default#delay
5 #max_attempts
20
You can modify defaults and register callbacks by passing a block argument.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4