Struct aws_sdk_cloudformation::types::AccountGateResult
source · #[non_exhaustive]pub struct AccountGateResult {
pub status: Option<AccountGateStatus>,
pub status_reason: Option<String>,
}
Expand description
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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.status: Option<AccountGateStatus>
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 toFAILED
. -
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_reason: Option<String>
The reason for the account gate status assigned to this account and Region for the stack set operation.
Implementations§
source§impl AccountGateResult
impl AccountGateResult
sourcepub fn status(&self) -> Option<&AccountGateStatus>
pub fn status(&self) -> Option<&AccountGateStatus>
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 toFAILED
. -
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.
-
sourcepub fn status_reason(&self) -> Option<&str>
pub fn status_reason(&self) -> Option<&str>
The reason for the account gate status assigned to this account and Region for the stack set operation.
source§impl AccountGateResult
impl AccountGateResult
sourcepub fn builder() -> AccountGateResultBuilder
pub fn builder() -> AccountGateResultBuilder
Creates a new builder-style object to manufacture AccountGateResult
.
Trait Implementations§
source§impl Clone for AccountGateResult
impl Clone for AccountGateResult
source§fn clone(&self) -> AccountGateResult
fn clone(&self) -> AccountGateResult
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AccountGateResult
impl Debug for AccountGateResult
source§impl PartialEq for AccountGateResult
impl PartialEq for AccountGateResult
source§fn eq(&self, other: &AccountGateResult) -> bool
fn eq(&self, other: &AccountGateResult) -> bool
self
and other
values to be equal, and is used
by ==
.