class Amazonite::CloudFormation::StackSetOperationSummary

Overview

The structures that contain summary information about the specified operation.

Defined in:

cloudformation/stack_set_operation_summary.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(operation_id : String | Nil = nil, action : StackSetOperationAction | Nil = nil, status : StackSetOperationStatus | Nil = nil, creation_timestamp : Time | Nil = nil, end_timestamp : Time | Nil = nil, status_reason : String | Nil = nil, status_details : StackSetOperationStatusDetails | Nil = nil, operation_preferences : StackSetOperationPreferences | 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 action : StackSetOperationAction | Nil #

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.


[View source]
def action=(action : StackSetOperationAction | Nil) #

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.


[View source]
def creation_timestamp : Time | Nil #

The time at which the operation was initiated. Note that the creation times for the StackSet operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.


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

The time at which the operation was initiated. Note that the creation times for the StackSet operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.


[View source]
def end_timestamp : Time | Nil #

The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.


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

The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.


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

See Object#hash(hasher)


def operation_id : String | Nil #

The unique ID of the StackSet operation.


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

The unique ID of the StackSet operation.


[View source]
def operation_preferences : StackSetOperationPreferences | Nil #

The user-specified preferences for how CloudFormation performs a StackSet operation.

For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.


[View source]
def operation_preferences=(operation_preferences : StackSetOperationPreferences | Nil) #

The user-specified preferences for how CloudFormation performs a StackSet operation.

For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.


[View source]
def status : StackSetOperationStatus | Nil #

The overall status of the operation.

  • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

  • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSet status codes in the CloudFormation User Guide.

  • RUNNING: The operation is currently being performed.

  • STOPPED: The user has canceled the operation.

  • STOPPING: The operation is in the process of stopping, at user request.

  • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.


[View source]
def status=(status : StackSetOperationStatus | Nil) #

The overall status of the operation.

  • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

  • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSet status codes in the CloudFormation User Guide.

  • RUNNING: The operation is currently being performed.

  • STOPPED: The user has canceled the operation.

  • STOPPING: The operation is in the process of stopping, at user request.

  • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.


[View source]
def status_details : StackSetOperationStatusDetails | Nil #

Detailed information about the StackSet operation.


[View source]
def status_details=(status_details : StackSetOperationStatusDetails | Nil) #

Detailed information about the StackSet operation.


[View source]
def status_reason : String | Nil #

The status of the operation in details.


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

The status of the operation in details.


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

[View source]
def validate! : Nil #

[View source]