software.amazon.awssdk.services.cloudformation.model

Interface StackInstance.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StackInstance.Builder,StackInstance>, SdkBuilder<StackInstance.Builder,StackInstance>, SdkPojo

Enclosing class:

StackInstance

public static interface StackInstance.Builder
extends SdkPojo, CopyableBuilder<StackInstance.Builder,StackInstance>

Method Summary

Modifier and Type	Method and Description
StackInstance.Builder	account(String account) [Self-managed permissions] The name of the AWS account that the stack instance is associated with.
StackInstance.Builder	driftStatus(StackDriftStatus driftStatus) Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
StackInstance.Builder	driftStatus(String driftStatus) Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
StackInstance.Builder	lastDriftCheckTimestamp(Instant lastDriftCheckTimestamp) Most recent time when CloudFormation performed a drift detection operation on the stack instance.
StackInstance.Builder	organizationalUnitId(String organizationalUnitId) [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
StackInstance.Builder	parameterOverrides(Collection<Parameter> parameterOverrides) A list of parameters from the stack set template whose values have been overridden in this stack instance.
StackInstance.Builder	parameterOverrides(Consumer<Parameter.Builder>... parameterOverrides) A list of parameters from the stack set template whose values have been overridden in this stack instance.
StackInstance.Builder	parameterOverrides(Parameter... parameterOverrides) A list of parameters from the stack set template whose values have been overridden in this stack instance.
StackInstance.Builder	region(String region) The name of the AWS Region that the stack instance is associated with.
StackInstance.Builder	stackId(String stackId) The ID of the stack instance.
StackInstance.Builder	stackSetId(String stackSetId) The name or unique ID of the stack set that the stack instance is associated with.
StackInstance.Builder	status(StackInstanceStatus status) The status of the stack instance, in terms of its synchronization with its associated stack set.
StackInstance.Builder	status(String status) The status of the stack instance, in terms of its synchronization with its associated stack set.
StackInstance.Builder	statusReason(String statusReason) The explanation for the specific status code that is assigned to this stack instance.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

stackSetId

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

region

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

account

StackInstance.Builder account(String account)

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

Parameters:

account - [Self-managed permissions] 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.

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 stack set template whose values have been overridden in this stack instance.

Parameters:

parameterOverrides - A list of parameters from the stack set 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 stack set template whose values have been overridden in this stack instance.

Parameters:

parameterOverrides - A list of parameters from the stack set 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 stack set template whose values have been overridden in this stack instance.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #parameterOverrides(List).

Parameters:

parameterOverrides - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#parameterOverrides(List)

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.

• 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, StackInstanceStatus

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.

• 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, StackInstanceStatus

statusReason

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

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

Parameters:

driftStatus - 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

StackDriftStatus, StackDriftStatus

driftStatus

StackInstance.Builder driftStatus(StackDriftStatus driftStatus)

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.

Parameters:

driftStatus - 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

StackDriftStatus, StackDriftStatus

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 on which drift detection has not yet been performed.

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 on which drift detection has not yet been performed.

Returns:

Returns a reference to this object so that method calls can be chained together.