com.amazonaws.services.cloudformation.model.AccountGateResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* 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 AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AccountGateResult implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*
*
*/
private String status;
/**
*
* The reason for the account gate status assigned to this account and Region for the stack set operation.
*
*/
private String 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.
*
*
*
*
*
*
* @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
*/
public void setStatus(String status) {
this.status = 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.
*
*
*
*
*
*
* @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 String getStatus() {
return this.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.
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountGateStatus
*/
public AccountGateResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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
*/
public void setStatus(AccountGateStatus status) {
withStatus(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.
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountGateStatus
*/
public AccountGateResult withStatus(AccountGateStatus status) {
this.status = status.toString();
return this;
}
/**
*
* 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.
*/
public void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
/**
*
* 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 String getStatusReason() {
return this.statusReason;
}
/**
*
* 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.
*/
public AccountGateResult withStatusReason(String statusReason) {
setStatusReason(statusReason);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusReason() != null)
sb.append("StatusReason: ").append(getStatusReason());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AccountGateResult == false)
return false;
AccountGateResult other = (AccountGateResult) obj;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStatusReason() == null ^ this.getStatusReason() == null)
return false;
if (other.getStatusReason() != null && other.getStatusReason().equals(this.getStatusReason()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode());
return hashCode;
}
@Override
public AccountGateResult clone() {
try {
return (AccountGateResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}