You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#accountString

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

Returns:

  • (String)


3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3649

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :status_reason)
  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:



3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3649

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :status_reason)
  include Aws::Structure
end

#regionString

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

Returns:

  • (String)


3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3649

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :status_reason)
  include Aws::Structure
end

#stack_idString

The ID of the stack instance.

Returns:

  • (String)


3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3649

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :status_reason)
  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)


3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3649

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :status_reason)
  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)


3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3649

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :status_reason)
  include Aws::Structure
end

#status_reasonString

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

Returns:

  • (String)


3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3649

class StackInstance < Struct.new(
  :stack_set_id,
  :region,
  :account,
  :stack_id,
  :parameter_overrides,
  :status,
  :status_reason)
  include Aws::Structure
end