Struct AccountGateResult

#[non_exhaustive]
pub struct AccountGateResult {
    pub status: Option<AccountGateStatus>,
    pub status_reason: Option<String>,
}

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 in StackSets in the CloudFormation User Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 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_reason: Option<String>

The reason for the account gate status assigned to this account and Region for the stack set operation.

Implementations

impl AccountGateResult

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 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.

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.

impl AccountGateResult

pub fn builder() -> AccountGateResultBuilder

Creates a new builder-style object to manufacture AccountGateResult.

Trait Implementations

impl Clone for AccountGateResult

fn clone(&self) -> AccountGateResult

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AccountGateResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AccountGateResult

fn eq(&self, other: &AccountGateResult) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AccountGateResult