Interface AccountGateResult.Builder

All Superinterfaces:

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

Enclosing class:

AccountGateResult

@Mutable
@NotThreadSafe
public static interface AccountGateResult.Builder
extends SdkPojo, CopyableBuilder<AccountGateResult.Builder,AccountGateResult>

Method Summary

Modifier and Type	Method	Description
AccountGateResult.Builder	status(String status)	The status of the account gate function.
AccountGateResult.Builder	status(AccountGateStatus status)	The status of the account gate function.
AccountGateResult.Builder	statusReason(String statusReason)	The reason for the account gate status assigned to this account and Region for the StackSet operation.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

status

AccountGateResult.Builder status(String status)

The status of the account gate function.

• SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.

• FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

• SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

  • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.

  • The AWSCloudFormationStackSetExecutionRole of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.

  • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.

Parameters:

status - The status of the account gate function.

• SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.

• FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

• SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

  • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.

  • The AWSCloudFormationStackSetExecutionRole of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.

  • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.

Returns:

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

See Also:

• AccountGateStatus
• AccountGateStatus

status

AccountGateResult.Builder status(AccountGateStatus status)

The status of the account gate function.

• SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.

• FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

• SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

  • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.

  • The AWSCloudFormationStackSetExecutionRole of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.

  • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.

Parameters:

status - The status of the account gate function.

• SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.

• FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

• SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

  • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.

  • The AWSCloudFormationStackSetExecutionRole of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.

  • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.

Returns:

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

See Also:

• AccountGateStatus
• AccountGateStatus

statusReason

AccountGateResult.Builder statusReason(String statusReason)

The reason for the account gate status assigned to this account and Region for the StackSet operation.

Parameters:

statusReason - The reason for the account gate status assigned to this account and Region for the StackSet operation.

Returns:

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