StackInstance (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudformation.model.StackInstance

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StackInstance
extends Object
implements Serializable, Cloneable
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StackInstance()

Constructors
Constructor and Description
`StackInstance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StackInstance`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccount()` The name of the AWS account that the stack instance is associated with.
`String`	`getRegion()` The name of the AWS region that the stack instance is associated with.
`String`	`getStackId()` The ID of the stack instance.
`String`	`getStackSetId()` The name or unique ID of the stack set that the stack instance is associated with.
`String`	`getStatus()` The status of the stack instance, in terms of its synchronization with its associated stack set.
`String`	`getStatusReason()` The explanation for the specific status code that is assigned to this stack instance.
`int`	`hashCode()`
`void`	`setAccount(String account)` The name of the AWS account that the stack instance is associated with.
`void`	`setRegion(String region)` The name of the AWS region that the stack instance is associated with.
`void`	`setStackId(String stackId)` The ID of the stack instance.
`void`	`setStackSetId(String stackSetId)` The name or unique ID of the stack set that the stack instance is associated with.
`void`	`setStatus(StackInstanceStatus status)` The status of the stack instance, in terms of its synchronization with its associated stack set.
`void`	`setStatus(String status)` The status of the stack instance, in terms of its synchronization with its associated stack set.
`void`	`setStatusReason(String statusReason)` The explanation for the specific status code that is assigned to this stack instance.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StackInstance`	`withAccount(String account)` The name of the AWS account that the stack instance is associated with.
`StackInstance`	`withRegion(String region)` The name of the AWS region that the stack instance is associated with.
`StackInstance`	`withStackId(String stackId)` The ID of the stack instance.
`StackInstance`	`withStackSetId(String stackSetId)` The name or unique ID of the stack set that the stack instance is associated with.
`StackInstance`	`withStatus(StackInstanceStatus status)` The status of the stack instance, in terms of its synchronization with its associated stack set.
`StackInstance`	`withStatus(String status)` The status of the stack instance, in terms of its synchronization with its associated stack set.
`StackInstance`	`withStatusReason(String statusReason)` The explanation for the specific status code that is assigned to this stack instance.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StackInstance
```
public StackInstance()
```
- Method Detail
  - setStackSetId
```
public void setStackSetId(String stackSetId)
```
    The name or unique ID of the stack set that the stack instance is associated with.
    
    Parameters:
    
    stackSetId - The name or unique ID of the stack set that the stack instance is associated with.
  - getStackSetId
```
public String getStackSetId()
```
    The name or unique ID of the stack set that the stack instance is associated with.
    
    Returns:
    
    The name or unique ID of the stack set that the stack instance is associated with.
  - withStackSetId
```
public StackInstance withStackSetId(String stackSetId)
```
    The name or unique ID of the stack set that the stack instance is associated with.
    
    Parameters:
    
    stackSetId - The name or unique ID of the stack set that the stack instance is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegion
```
public void setRegion(String region)
```
    The name of the AWS region that the stack instance is associated with.
    
    Parameters:
    
    region - The name of the AWS region that the stack instance is associated with.
  - getRegion
```
public String getRegion()
```
    The name of the AWS region that the stack instance is associated with.
    
    Returns:
    
    The name of the AWS region that the stack instance is associated with.
  - withRegion
```
public StackInstance withRegion(String region)
```
    The name of the AWS region that the stack instance is associated with.
    
    Parameters:
    
    region - The name of the AWS region that the stack instance is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccount
```
public void setAccount(String account)
```
    The name of the AWS account that the stack instance is associated with.
    
    Parameters:
    
    account - The name of the AWS account that the stack instance is associated with.
  - getAccount
```
public String getAccount()
```
    The name of the AWS account that the stack instance is associated with.
    
    Returns:
    
    The name of the AWS account that the stack instance is associated with.
  - withAccount
```
public StackInstance withAccount(String account)
```
    The name of the AWS account that the stack instance is associated with.
    
    Parameters:
    
    account - The name of the AWS account that the stack instance is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStackId
```
public void setStackId(String stackId)
```
    The ID of the stack instance.
    
    Parameters:
    
    stackId - The ID of the stack instance.
  - getStackId
```
public String getStackId()
```
    The ID of the stack instance.
    
    Returns:
    
    The ID of the stack instance.
  - withStackId
```
public StackInstance withStackId(String stackId)
```
    The ID of the stack instance.
    
    Parameters:
    
    stackId - The ID of the stack instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    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.
    Parameters:
    status - 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.
    See Also:
    
    StackInstanceStatus
  - getStatus
```
public String getStatus()
```
    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:
    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.
    See Also:
    
    StackInstanceStatus
  - withStatus
```
public StackInstance withStatus(String status)
```
    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.
    Parameters:
    status - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackInstanceStatus
  - setStatus
```
public void setStatus(StackInstanceStatus status)
```
    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.
    Parameters:
    status - 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.
    See Also:
    
    StackInstanceStatus
  - withStatus
```
public StackInstance withStatus(StackInstanceStatus status)
```
    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.
    Parameters:
    status - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackInstanceStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The explanation for the specific status code that is assigned to this stack instance.
    
    Parameters:
    
    statusReason - The explanation for the specific status code that is assigned to this stack instance.
  - getStatusReason
```
public String getStatusReason()
```
    The explanation for the specific status code that is assigned to this stack instance.
    
    Returns:
    
    The explanation for the specific status code that is assigned to this stack instance.
  - withStatusReason
```
public StackInstance withStatusReason(String statusReason)
```
    The explanation for the specific status code that is assigned to this stack instance.
    
    Parameters:
    
    statusReason - The explanation for the specific status code that is assigned to this stack instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StackInstance clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class StackInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StackInstance

Method Detail

setStackSetId

getStackSetId

withStackSetId

setRegion

getRegion

withRegion

setAccount

getAccount

withAccount

setStackId

getStackId

withStackId

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

toString

equals

hashCode

clone