software.amazon.awssdk.services.cloudformation.model.AccountGateResult Maven / Gradle / Ivy
Show all versions of cloudformation Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudformation.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AccountGateResult implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(AccountGateResult::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField STATUS_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StatusReason").getter(getter(AccountGateResult::statusReason)).setter(setter(Builder::statusReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StatusReason").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATUS_FIELD,
STATUS_REASON_FIELD));
private static final long serialVersionUID = 1L;
private final String status;
private final String statusReason;
private AccountGateResult(BuilderImpl builder) {
this.status = builder.status;
this.statusReason = builder.statusReason;
}
/**
*
* 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, {@link #status} will
* return {@link AccountGateStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return 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 AccountGateStatus
*/
public final AccountGateStatus status() {
return AccountGateStatus.fromValue(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, {@link #status} will
* return {@link AccountGateStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return 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 AccountGateStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The reason for the account gate status assigned to this account and Region for the stack set operation.
*
*
* @return The reason for the account gate status assigned to this account and Region for the stack set operation.
*/
public final String statusReason() {
return statusReason;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusReason());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AccountGateResult)) {
return false;
}
AccountGateResult other = (AccountGateResult) obj;
return Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(statusReason(), other.statusReason());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("AccountGateResult").add("Status", statusAsString()).add("StatusReason", statusReason()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "StatusReason":
return Optional.ofNullable(clazz.cast(statusReason()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AccountGateResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
*
*
*
*
* @param 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.
*
*
*
*
* @see AccountGateStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountGateStatus
*/
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 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.
*
*
*
*
*
*
* @param 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.
*
*
*
*
* @see AccountGateStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountGateStatus
*/
Builder status(AccountGateStatus status);
/**
*
* The reason for the account gate status assigned to this account and Region for the stack set operation.
*
*
* @param statusReason
* The reason for the account gate status assigned to this account and Region for the stack set
* operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statusReason(String statusReason);
}
static final class BuilderImpl implements Builder {
private String status;
private String statusReason;
private BuilderImpl() {
}
private BuilderImpl(AccountGateResult model) {
status(model.status);
statusReason(model.statusReason);
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(AccountGateStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getStatusReason() {
return statusReason;
}
public final void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
@Override
public final Builder statusReason(String statusReason) {
this.statusReason = statusReason;
return this;
}
@Override
public AccountGateResult build() {
return new AccountGateResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}