software.amazon.awssdk.services.cloudformation.model

Interface StackSetOperationResultSummary.Builder

All Superinterfaces:

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

Enclosing class:

StackSetOperationResultSummary

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

Method Summary

Modifier and Type	Method and Description
StackSetOperationResultSummary.Builder	account(String account) [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
StackSetOperationResultSummary.Builder	accountGateResult(AccountGateResult accountGateResult) The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account
default StackSetOperationResultSummary.Builder	accountGateResult(Consumer<AccountGateResult.Builder> accountGateResult) The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account
StackSetOperationResultSummary.Builder	organizationalUnitId(String organizationalUnitId) [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
StackSetOperationResultSummary.Builder	region(String region) The name of the Amazon Web Services Region for this operation result.
StackSetOperationResultSummary.Builder	status(StackSetOperationResultStatus status) The result status of the stack set operation for the given account in the given Region.
StackSetOperationResultSummary.Builder	status(String status) The result status of the stack set operation for the given account in the given Region.
StackSetOperationResultSummary.Builder	statusReason(String statusReason) The reason for the assigned result status.

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

account

StackSetOperationResultSummary.Builder account(String account)

[Self-managed permissions] The name of the Amazon Web Services account for this operation result.

Parameters:

account - [Self-managed permissions] The name of the Amazon Web Services account for this operation result.

Returns:

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

region

StackSetOperationResultSummary.Builder region(String region)

The name of the Amazon Web Services Region for this operation result.

Parameters:

region - The name of the Amazon Web Services Region for this operation result.

Returns:

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

status

StackSetOperationResultSummary.Builder status(String status)

The result status of the stack set operation for the given account in the given Region.

• CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

• FAILED: The operation in the specified account and Region failed.

  If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

• RUNNING: The operation in the specified account and Region is currently in progress.

• PENDING: The operation in the specified account and Region has yet to start.

• SUCCEEDED: The operation in the specified account and Region completed successfully.

Parameters:

status - The result status of the stack set operation for the given account in the given Region.

• CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

• FAILED: The operation in the specified account and Region failed.

  If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

• RUNNING: The operation in the specified account and Region is currently in progress.

• PENDING: The operation in the specified account and Region has yet to start.

• SUCCEEDED: The operation in the specified account and Region completed successfully.

Returns:

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

See Also:

StackSetOperationResultStatus, StackSetOperationResultStatus

status

StackSetOperationResultSummary.Builder status(StackSetOperationResultStatus status)

The result status of the stack set operation for the given account in the given Region.

• CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

• FAILED: The operation in the specified account and Region failed.

  If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

• RUNNING: The operation in the specified account and Region is currently in progress.

• PENDING: The operation in the specified account and Region has yet to start.

• SUCCEEDED: The operation in the specified account and Region completed successfully.

Parameters:

status - The result status of the stack set operation for the given account in the given Region.

• CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

• FAILED: The operation in the specified account and Region failed.

  If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

• RUNNING: The operation in the specified account and Region is currently in progress.

• PENDING: The operation in the specified account and Region has yet to start.

• SUCCEEDED: The operation in the specified account and Region completed successfully.

Returns:

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

See Also:

StackSetOperationResultStatus, StackSetOperationResultStatus

statusReason

StackSetOperationResultSummary.Builder statusReason(String statusReason)

The reason for the assigned result status.

Parameters:

statusReason - The reason for the assigned result status.

Returns:

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

accountGateResult

StackSetOperationResultSummary.Builder accountGateResult(AccountGateResult accountGateResult)

The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account

Parameters:

accountGateResult - The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account

Returns:

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

accountGateResult

default StackSetOperationResultSummary.Builder accountGateResult(Consumer<AccountGateResult.Builder> accountGateResult)

The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account

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

Parameters:

accountGateResult - a consumer that will call methods on AccountGateResult.Builder

Returns:

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

See Also:

accountGateResult(AccountGateResult)

organizationalUnitId

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