class Amazonite::CloudFormation::DescribeChangeSetOutput

Overview

The output for the DescribeChangeSet action.

Defined in:

cloudformation/describe_change_set_output.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(change_set_name : String | Nil = nil, change_set_id : String | Nil = nil, stack_id : String | Nil = nil, stack_name : String | Nil = nil, description : String | Nil = nil, parameters : Array(Parameter) | Nil = nil, creation_time : Time | Nil = nil, execution_status : ExecutionStatus | Nil = nil, status : ChangeSetStatus | Nil = nil, status_reason : String | Nil = nil, stack_drift_status : StackDriftStatus | Nil = nil, notification_ar_ns : Array(String) | Nil = nil, rollback_configuration : RollbackConfiguration | Nil = nil, capabilities : Array(Capability) | Nil = nil, tags : Array(Tag) | Nil = nil, changes : Array(Change) | Nil = nil, next_token : String | Nil = nil, include_nested_stacks : Bool | Nil = nil, parent_change_set_id : String | Nil = nil, root_change_set_id : String | Nil = nil, on_stack_failure : OnStackFailure | Nil = nil, import_existing_resources : Bool | Nil = nil, deployment_mode : DeploymentMode | Nil = nil, deployment_config : DeploymentConfig | 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 #

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.


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

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.


[View source]
def change_set_id : String | Nil #

The Amazon Resource Name (ARN) of the change set.


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

The Amazon Resource Name (ARN) of the change set.


[View source]
def change_set_name : String | Nil #

The name of the change set.


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

The name of the change set.


[View source]
def changes : Array(Change) | Nil #

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.


[View source]
def changes=(changes : Array(Change) | Nil) #

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.


[View source]
def creation_time : Time | Nil #

The start time when the change set was created, in UTC.


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

The start time when the change set was created, in UTC.


[View source]
def deployment_config : DeploymentConfig | Nil #

The deployment configuration specified when the change set was created.


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

The deployment configuration specified when the change set was created.


[View source]
def deployment_mode : DeploymentMode | Nil #

The deployment mode specified when the change set was created. Valid value is REVERT_DRIFT. Only present for drift-aware change sets.


[View source]
def deployment_mode=(deployment_mode : DeploymentMode | Nil) #

The deployment mode specified when the change set was created. Valid value is REVERT_DRIFT. Only present for drift-aware change sets.


[View source]
def description : String | Nil #

Information about the change set.


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

Information about the change set.


[View source]
def execution_status : ExecutionStatus | Nil #

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.


[View source]
def execution_status=(execution_status : ExecutionStatus | Nil) #

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.


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

See Object#hash(hasher)


def import_existing_resources : Bool | Nil #

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.


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

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.


[View source]
def include_nested_stacks : Bool | Nil #

Verifies if IncludeNestedStacks is set to True.


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

Verifies if IncludeNestedStacks is set to True.


[View source]
def next_token : String | Nil #

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.


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

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.


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

The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.


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

The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.


[View source]
def on_stack_failure : OnStackFailure | Nil #

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

  • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

  • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.


[View source]
def on_stack_failure=(on_stack_failure : OnStackFailure | Nil) #

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

  • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

  • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.


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

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.


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

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.


[View source]
def parent_change_set_id : String | Nil #

Specifies the change set ID of the parent change set in the current nested change set hierarchy.


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

Specifies the change set ID of the parent change set in the current nested change set hierarchy.


[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_change_set_id : String | Nil #

Specifies the change set ID of the root change set in the current nested change set hierarchy.


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

Specifies the change set ID of the root change set in the current nested change set hierarchy.


[View source]
def stack_drift_status : StackDriftStatus | Nil #

The drift status of the stack when the change set was created. Valid values:

  • DRIFTED – The stack has drifted from its last deployment.

  • IN_SYNC – The stack is in sync with its last deployment.

  • NOT_CHECKED – CloudFormation doesn’t currently return this value.

  • UNKNOWN – The drift status could not be determined.

Only present for drift-aware change sets.


[View source]
def stack_drift_status=(stack_drift_status : StackDriftStatus | Nil) #

The drift status of the stack when the change set was created. Valid values:

  • DRIFTED – The stack has drifted from its last deployment.

  • IN_SYNC – The stack is in sync with its last deployment.

  • NOT_CHECKED – CloudFormation doesn’t currently return this value.

  • UNKNOWN – The drift status could not be determined.

Only present for drift-aware change sets.


[View source]
def stack_id : String | Nil #

The Amazon Resource Name (ARN) of the stack that's associated with the change set.


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

The Amazon Resource Name (ARN) of the stack that's associated with the change set.


[View source]
def stack_name : String | Nil #

The name of the stack that's associated with the change set.


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

The name of the stack that's associated with the change set.


[View source]
def status : ChangeSetStatus | Nil #

The current status of the change set, such as CREATE_PENDING, CREATE_COMPLETE, or FAILED.


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

The current status of the change set, such as CREATE_PENDING, CREATE_COMPLETE, or FAILED.


[View source]
def status_reason : String | Nil #

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.


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

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.


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

If you execute the change set, the tags that will be associated with the stack.


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

If you execute the change set, the tags that will be associated with the stack.


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

[View source]
def validate! : Nil #

[View source]