AccountGateResult
Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.
For each account and Region, AWS 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.
Contents
- 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. AWS 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. AWS CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region toFAILED
. -
SKIPPED
: AWS 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. AWS 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. AWS 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. AWS CloudFormation skips the stack set operation in this account and Region.
-
Type: String
Valid Values:
SUCCEEDED | FAILED | SKIPPED
Required: No
-
- StatusReason
-
The reason for the account gate status assigned to this account and Region for the stack set operation.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: