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

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

Overview

A CloudFormation stack, in a specific account and Region, that's part of a StackSet 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 StackSet. Each stack instance contains the ID of its associated StackSet, in addition to 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 Amazon Web Services account that the stack instance is associated with.

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_statusString

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 StackSset configuration.

  • UNKNOWN: This value is reserved for future use.

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_timestampTime

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.

Returns:

  • (Time)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_idString

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

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_idString

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

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_overridesArray<Types::Parameter>

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

Returns:



8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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

#regionString

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

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_idString

The ID of the stack instance.

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_statusTypes::StackInstanceComprehensiveStatus

The detailed status of the stack instance.



8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_idString

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

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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

#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. 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 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.

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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_reasonString

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

Returns:

  • (String)


8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 8588

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