Interface StackInstance.Builder

All Superinterfaces:
Buildable, CopyableBuilder<StackInstance.Builder,StackInstance>, SdkBuilder<StackInstance.Builder,StackInstance>, SdkPojo
Enclosing class:
StackInstance
@Mutable @NotThreadSafe public static interface StackInstance.Builder extends SdkPojo, CopyableBuilder<StackInstance.Builder,StackInstance>

  • Method Details

    • stackSetId

      StackInstance.Builder stackSetId(String stackSetId)

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

      Parameters:
      stackSetId - The name or unique ID of the StackSet that the stack instance is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      StackInstance.Builder region(String region)

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

      Parameters:
      region - The name of the Amazon Web Services Region that the stack instance is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • account

      StackInstance.Builder account(String account)

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

      Parameters:
      account - [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackId

      StackInstance.Builder stackId(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.

    • parameterOverrides

      StackInstance.Builder parameterOverrides(Collection<Parameter> parameterOverrides)

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

      Parameters:
      parameterOverrides - A list of parameters from the StackSet template whose values have been overridden in this stack instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterOverrides

      StackInstance.Builder parameterOverrides(Parameter... parameterOverrides)

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

      Parameters:
      parameterOverrides - A list of parameters from the StackSet template whose values have been overridden in this stack instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterOverrides

      StackInstance.Builder parameterOverrides(Consumer<Parameter.Builder>... parameterOverrides)

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

      This is a convenience method that creates an instance of the Parameter.Builder avoiding the need to create one manually via Parameter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterOverrides(List<Parameter>).

      Parameters:
      parameterOverrides - a consumer that will call methods on Parameter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      StackInstance.Builder status(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. 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.

      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. 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      StackInstance.Builder status(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. 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.

      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. 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stackInstanceStatus

      StackInstance.Builder stackInstanceStatus(StackInstanceComprehensiveStatus stackInstanceStatus)

      The detailed status of the stack instance.

      Parameters:
      stackInstanceStatus - The detailed status of the stack instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackInstanceStatus

      default StackInstance.Builder stackInstanceStatus(Consumer<StackInstanceComprehensiveStatus.Builder> stackInstanceStatus)

      The detailed status of the stack instance.

      This is a convenience method that creates an instance of the StackInstanceComprehensiveStatus.Builder avoiding the need to create one manually via StackInstanceComprehensiveStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stackInstanceStatus(StackInstanceComprehensiveStatus).

      Parameters:
      stackInstanceStatus - a consumer that will call methods on StackInstanceComprehensiveStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      StackInstance.Builder statusReason(String statusReason)

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

      Parameters:
      statusReason - The explanation for the specific status code that's assigned to this stack instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationalUnitId

      StackInstance.Builder organizationalUnitId(String organizationalUnitId)

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

      Parameters:
      organizationalUnitId - [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • driftStatus

      StackInstance.Builder driftStatus(String driftStatus)

      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.

      Parameters:
      driftStatus - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • driftStatus

      StackInstance.Builder driftStatus(StackDriftStatus driftStatus)

      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.

      Parameters:
      driftStatus - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastDriftCheckTimestamp

      StackInstance.Builder lastDriftCheckTimestamp(Instant lastDriftCheckTimestamp)

      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.

      Parameters:
      lastDriftCheckTimestamp - 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:
      Returns a reference to this object so that method calls can be chained together.

    • lastOperationId

      StackInstance.Builder lastOperationId(String lastOperationId)

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

      Parameters:
      lastOperationId - The last unique ID of a StackSet operation performed on a stack instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.