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 stack set 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 stack set operation in that account and Region. CloudFormation invokes the function each time a stack set 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 stack set operation result status for that account and Region to FAILED.

For more information, see Configuring a target account gate.

See Also:
  • Method Details

    • 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 stack set 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 stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set 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 stack set operation in this account and Region.

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

        • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set 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 stack set 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 stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set 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 stack set operation in this account and Region.

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

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

      See Also:
    • 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 stack set 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 stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set 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 stack set operation in this account and Region.

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

        • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set 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 stack set 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 stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set 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 stack set operation in this account and Region.

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

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

      See Also:
    • statusReason

      public final String statusReason()

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

      Returns:
      The reason for the account gate status assigned to this account and Region for the stack set operation.
    • toBuilder

      public AccountGateResult.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AccountGateResult.Builder,AccountGateResult>
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.