Class: Aws::CloudFormation::Types::StackInstance

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::StackInstance

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

Overview

A CloudFormation stack, in a specific account and Region, that’s part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn’t be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the actual stack and the stack status.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account ⇒ String

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

• #drift_status ⇒ String

  Status of the stack instance’s actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

• #last_drift_check_timestamp ⇒ Time

  Most recent time when CloudFormation performed a drift detection operation on the stack instance.

• #last_operation_id ⇒ String

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

• #organizational_unit_id ⇒ String

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

• #parameter_overrides ⇒ Array<Types::Parameter>

  A list of parameters from the stack set template whose values have been overridden in this stack instance.

• #region ⇒ String

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

• #stack_id ⇒ String

  The ID of the stack instance.

• #stack_instance_status ⇒ Types::StackInstanceComprehensiveStatus

  The detailed status of the stack instance.

• #stack_set_id ⇒ String

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

• #status ⇒ String

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

• #status_reason ⇒ String

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

Instance Attribute Details

#account ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#drift_status ⇒ String

Status of the stack instance’s actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

• ‘DRIFTED`: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. 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 stack set configuration.

• ‘IN_SYNC`: The stack instance’s actual configuration matches its expected stack set configuration.

• ‘UNKNOWN`: This value is reserved for future use.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#last_drift_check_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#last_operation_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_id ⇒ String

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_overrides ⇒ Array<Types::Parameter>

A list of parameters from the stack set template whose values have been overridden in this stack instance.

Returns:

• (Array<Types::Parameter>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The ID of the stack instance.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_instance_status ⇒ Types::StackInstanceComprehensiveStatus

The detailed status of the stack instance.

Returns:

• (Types::StackInstanceComprehensiveStatus)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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, look at the ‘DetailedStatus` member in the `StackInstanceSummary` member that is a peer to this `Status` member.

• ‘OUTDATED`: The stack isn’t currently up to date with the stack set 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 stack set.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 8135

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :stack_instance_status,
  :status_reason,
  :organizational_unit_id,
  :drift_status,
  :last_drift_check_timestamp,
  :last_operation_id)
  SENSITIVE = []
  include Aws::Structure
end