class Amazonite::CloudFormation::Stack

Overview

The Stack data type.

Defined in:

cloudformation/stack.cr

Constructors

Instance Method Summary

Constructor Detail

def self.from_xml(node : XML::Node) : self #

[View source]
def self.new(stack_name : String, creation_time : Time, stack_status : StackStatus, stack_id : String | Nil = nil, change_set_id : String | Nil = nil, description : String | Nil = nil, parameters : Array(Parameter) | Nil = nil, deletion_time : Time | Nil = nil, last_updated_time : Time | Nil = nil, rollback_configuration : RollbackConfiguration | Nil = nil, stack_status_reason : String | Nil = nil, disable_rollback : Bool | Nil = nil, deployment_config : DeploymentConfig | Nil = nil, notification_ar_ns : Array(String) | Nil = nil, timeout_in_minutes : Int32 | Nil = nil, capabilities : Array(Capability) | Nil = nil, outputs : Array(Output) | Nil = nil, role_arn : String | Nil = nil, tags : Array(Tag) | Nil = nil, enable_termination_protection : Bool | Nil = nil, parent_id : String | Nil = nil, root_id : String | Nil = nil, drift_information : StackDriftInformation | Nil = nil, retain_except_on_create : Bool | Nil = nil, deletion_mode : DeletionMode | Nil = nil, detailed_status : DetailedStatus | Nil = nil, last_operations : Array(OperationEntry) | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def capabilities : Array(Capability) | Nil #

The capabilities allowed in the stack.


[View source]
def capabilities=(capabilities : Array(Capability) | Nil) #

The capabilities allowed in the stack.


[View source]
def change_set_id : String | Nil #

The unique ID of the change set.


[View source]
def change_set_id=(change_set_id : String | Nil) #

The unique ID of the change set.


[View source]
def creation_time : Time #

The time at which the stack was created.


[View source]
def creation_time=(creation_time : Time) #

The time at which the stack was created.


[View source]
def deletion_mode : DeletionMode | Nil #

Specifies the deletion mode for the stack. Possible values are:

  • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

  • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.


[View source]
def deletion_mode=(deletion_mode : DeletionMode | Nil) #

Specifies the deletion mode for the stack. Possible values are:

  • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

  • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.


[View source]
def deletion_time : Time | Nil #

The time the stack was deleted.


[View source]
def deletion_time=(deletion_time : Time | Nil) #

The time the stack was deleted.


[View source]
def deployment_config : DeploymentConfig | Nil #

The deployment configuration for the stack, including the deployment mode used for stack operations.


[View source]
def deployment_config=(deployment_config : DeploymentConfig | Nil) #

The deployment configuration for the stack, including the deployment mode used for stack operations.


[View source]
def description : String | Nil #

A user-defined description associated with the stack.


[View source]
def description=(description : String | Nil) #

A user-defined description associated with the stack.


[View source]
def detailed_status : DetailedStatus | Nil #

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The StackSets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.


[View source]
def detailed_status=(detailed_status : DetailedStatus | Nil) #

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The StackSets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.


[View source]
def disable_rollback : Bool | Nil #

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback.

  • false: enable rollback.


[View source]
def disable_rollback=(disable_rollback : Bool | Nil) #

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback.

  • false: enable rollback.


[View source]
def drift_information : StackDriftInformation | Nil #

Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.


[View source]
def drift_information=(drift_information : StackDriftInformation | Nil) #

Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.


[View source]
def enable_termination_protection : Bool | Nil #

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 Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.


[View source]
def enable_termination_protection=(enable_termination_protection : Bool | Nil) #

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 Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def last_operations : Array(OperationEntry) | Nil #

Information about the most recent operations performed on this stack.


[View source]
def last_operations=(last_operations : Array(OperationEntry) | Nil) #

Information about the most recent operations performed on this stack.


[View source]
def last_updated_time : Time | Nil #

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.


[View source]
def last_updated_time=(last_updated_time : Time | Nil) #

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.


[View source]
def notification_ar_ns : Array(String) | Nil #

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.


[View source]
def notification_ar_ns=(notification_ar_ns : Array(String) | Nil) #

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.


[View source]
def outputs : Array(Output) | Nil #

A list of output structures.


[View source]
def outputs=(outputs : Array(Output) | Nil) #

A list of output structures.


[View source]
def parameters : Array(Parameter) | Nil #

A list of Parameter structures.


[View source]
def parameters=(parameters : Array(Parameter) | Nil) #

A list of Parameter structures.


[View source]
def parent_id : String | Nil #

For nested stacks, 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 Nested stacks in the CloudFormation User Guide.


[View source]
def parent_id=(parent_id : String | Nil) #

For nested stacks, 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 Nested stacks in the CloudFormation User Guide.


[View source]
def retain_except_on_create : Bool | Nil #

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false


[View source]
def retain_except_on_create=(retain_except_on_create : Bool | Nil) #

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false


[View source]
def role_arn : String | Nil #

The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.


[View source]
def role_arn=(role_arn : String | Nil) #

The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.


[View source]
def rollback_configuration : RollbackConfiguration | Nil #

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


[View source]
def rollback_configuration=(rollback_configuration : RollbackConfiguration | Nil) #

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


[View source]
def root_id : String | Nil #

For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Nested stacks in the CloudFormation User Guide.


[View source]
def root_id=(root_id : String | Nil) #

For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Nested stacks in the CloudFormation User Guide.


[View source]
def stack_id : String | Nil #

Unique identifier of the stack.


[View source]
def stack_id=(stack_id : String | Nil) #

Unique identifier of the stack.


[View source]
def stack_name : String #

The name associated with the stack.


[View source]
def stack_name=(stack_name : String) #

The name associated with the stack.


[View source]
def stack_status : StackStatus #

Current status of the stack.


[View source]
def stack_status=(stack_status : StackStatus) #

Current status of the stack.


[View source]
def stack_status_reason : String | Nil #

Success/failure message associated with the stack status.


[View source]
def stack_status_reason=(stack_status_reason : String | Nil) #

Success/failure message associated with the stack status.


[View source]
def tags : Array(Tag) | Nil #

A list of Tags that specify information about the stack.


[View source]
def tags=(tags : Array(Tag) | Nil) #

A list of Tags that specify information about the stack.


[View source]
def timeout_in_minutes : Int32 | Nil #

The amount of time within which stack creation should complete.


[View source]
def timeout_in_minutes=(timeout_in_minutes : Int32 | Nil) #

The amount of time within which stack creation should complete.


[View source]
def to_query_params(prefix : String) : Array(Tuple(String, String)) #

[View source]
def validate! : Nil #

[View source]