class Amazonite::CloudFormation::StackInstanceSummary

Overview

The structure that contains summary information about a stack instance.

Defined in:

cloudformation/stack_instance_summary.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(stack_set_id : String | Nil = nil, region : String | Nil = nil, account : String | Nil = nil, stack_id : String | Nil = nil, status : StackInstanceStatus | Nil = nil, status_reason : String | Nil = nil, stack_instance_status : StackInstanceComprehensiveStatus | Nil = nil, organizational_unit_id : String | Nil = nil, drift_status : StackDriftStatus | Nil = nil, last_drift_check_timestamp : Time | Nil = nil, last_operation_id : String | 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 account : String | Nil #

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.


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

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.


[View source]
def drift_status : StackDriftStatus | Nil #

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.

  • DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.

  • IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.

  • UNKNOWN: This value is reserved for future use.


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

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.

  • DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.

  • IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.

  • UNKNOWN: This value is reserved for future use.


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

See Object#hash(hasher)


def last_drift_check_timestamp : Time | Nil #

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance that drift detection hasn't yet been performed on.


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

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance that drift detection hasn't yet been performed on.


[View source]
def last_operation_id : String | Nil #

The last unique ID of a StackSet operation performed on a stack instance.


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

The last unique ID of a StackSet operation performed on a stack instance.


[View source]
def organizational_unit_id : String | Nil #

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.


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

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.


[View source]
def region : String | Nil #

The name of the Amazon Web Services Region that the stack instance is associated with.


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

The name of the Amazon Web Services Region that the stack instance is associated with.


[View source]
def stack_id : String | Nil #

The ID of the stack instance.


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

The ID of the stack instance.


[View source]
def stack_instance_status : StackInstanceComprehensiveStatus | Nil #

The detailed status of the stack instance.


[View source]
def stack_instance_status=(stack_instance_status : StackInstanceComprehensiveStatus | Nil) #

The detailed status of the stack instance.


[View source]
def stack_set_id : String | Nil #

The name or unique ID of the StackSet that the stack instance is associated with.


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

The name or unique ID of the StackSet that the stack instance is associated with.


[View source]
def status : StackInstanceStatus | Nil #

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.

  • OUTDATED: The stack isn't currently up to date with the StackSet because:

  • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

  • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the StackSet.


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

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.

  • OUTDATED: The stack isn't currently up to date with the StackSet because:

  • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

  • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the StackSet.


[View source]
def status_reason : String | Nil #

The explanation for the specific status code assigned to this stack instance.


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

The explanation for the specific status code assigned to this stack instance.


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

[View source]
def validate! : Nil #

[View source]