@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AccountGateResult extends Object implements Serializable, Cloneable
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.
Constructor and Description |
---|
AccountGateResult() |
Modifier and Type | Method and Description |
---|---|
AccountGateResult |
clone() |
boolean |
equals(Object obj) |
String |
getStatus()
The status of the account gate function.
|
String |
getStatusReason()
The reason for the account gate status assigned to this account and Region for the stack set operation.
|
int |
hashCode() |
void |
setStatus(AccountGateStatus status)
The status of the account gate function.
|
void |
setStatus(String status)
The status of the account gate function.
|
void |
setStatusReason(String statusReason)
The reason for the account gate status assigned to this account and Region for the stack set operation.
|
String |
toString()
Returns a string representation of this object.
|
AccountGateResult |
withStatus(AccountGateStatus status)
The status of the account gate function.
|
AccountGateResult |
withStatus(String status)
The status of the account gate function.
|
AccountGateResult |
withStatusReason(String statusReason)
The reason for the account gate status assigned to this account and Region for the stack set operation.
|
public void setStatus(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.
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.
AccountGateStatus
public String getStatus()
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.
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.
AccountGateStatus
public AccountGateResult withStatus(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.
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.
AccountGateStatus
public void setStatus(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.
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.
AccountGateStatus
public AccountGateResult withStatus(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.
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.
AccountGateStatus
public void setStatusReason(String statusReason)
The reason for the account gate status assigned to this account and Region for the stack set operation.
statusReason
- The reason for the account gate status assigned to this account and Region for the stack set operation.public String getStatusReason()
The reason for the account gate status assigned to this account and Region for the stack set operation.
public AccountGateResult withStatusReason(String statusReason)
The reason for the account gate status assigned to this account and Region for the stack set operation.
statusReason
- The reason for the account gate status assigned to this account and Region for the stack set operation.public String toString()
toString
in class Object
Object.toString()
public AccountGateResult clone()