Package software.amazon.awssdk.services.cloudformation.model

Class AccountGateResult

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.AccountGateResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AccountGateResult.Builder,AccountGateResult>

@Generated("software.amazon.awssdk:codegen")
public final class AccountGateResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AccountGateResult.Builder,AccountGateResult>

Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a StackSet operation in an account and Region.

For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any requirements that must be met before CloudFormation can proceed with a StackSet operation in that account and Region. CloudFormation invokes the function each time a StackSet operation is requested for that account and Region; if the function returns FAILED, CloudFormation cancels the operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

For more information, see Prevent failed StackSets deployments using target account gates in the CloudFormation User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccountGateResult.Builder

Method Summary

Modifier and Type	Method	Description
static AccountGateResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AccountGateResult.Builder>	serializableBuilderClass()
AccountGateStatus	status()	The status of the account gate function.
String	statusAsString()	The status of the account gate function.
String	statusReason()	The reason for the account gate status assigned to this account and Region for the StackSet operation.
AccountGateResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

status

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

If the service returns an enum value that is not available in the current SDK version, status will return AccountGateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

AccountGateStatus

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return AccountGateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

AccountGateStatus

statusReason

public final String statusReason()

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

Returns:

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

toBuilder

public AccountGateResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccountGateResult.Builder,AccountGateResult>

builder

public static AccountGateResult.Builder builder()

serializableBuilderClass

public static Class<? extends AccountGateResult.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo