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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

An AWS 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, as well as the ID of the actual stack and the stack status.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accountString

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

Returns:

  • (String)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#drift_statusString

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: AWS CloudFormation has not 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)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_drift_check_timestampTime

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 has not yet been performed.

Returns:

  • (Time)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_idString

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

Returns:

  • (String)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_overridesArray<Types::Parameter>

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

Returns:



5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

The name of the AWS Region that the stack instance is associated with.

Returns:

  • (String)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_idString

The ID of the stack instance.

Returns:

  • (String)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_instance_statusTypes::StackInstanceComprehensiveStatus

The detailed status of the stack instance.



5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_idString

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

Returns:

  • (String)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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.

  • 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)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonString

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

Returns:

  • (String)


5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 5697

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)
  SENSITIVE = []
  include Aws::Structure
end