Amazonka.CloudFormation.Types.AccountGateResult

Documentation

data AccountGateResult

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: newAccountGateResult smart constructor.

Constructors

AccountGateResult'

Fields

• status :: Maybe 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.
• statusReason :: Maybe Text

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

Instances

FromXML AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

Methods

parseXML :: [Node] -> Either String AccountGateResult

Generic AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

Associated Types

type Rep AccountGateResult :: Type -> Type

Methods

from :: AccountGateResult -> Rep AccountGateResult x

to :: Rep AccountGateResult x -> AccountGateResult

Read AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

Methods

readsPrec :: Int -> ReadS AccountGateResult

readList :: ReadS [AccountGateResult]

readPrec :: ReadPrec AccountGateResult

readListPrec :: ReadPrec [AccountGateResult]

Show AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

Methods

showsPrec :: Int -> AccountGateResult -> ShowS

show :: AccountGateResult -> String

showList :: [AccountGateResult] -> ShowS

NFData AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

Methods

rnf :: AccountGateResult -> ()

Eq AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

Methods

(==) :: AccountGateResult -> AccountGateResult -> Bool

(/=) :: AccountGateResult -> AccountGateResult -> Bool

Hashable AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

Methods

hashWithSalt :: Int -> AccountGateResult -> Int

hash :: AccountGateResult -> Int

type Rep AccountGateResult

Defined in Amazonka.CloudFormation.Types.AccountGateResult

type Rep AccountGateResult = D1 ('MetaData "AccountGateResult" "Amazonka.CloudFormation.Types.AccountGateResult" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "AccountGateResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountGateStatus)) :*: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAccountGateResult :: AccountGateResult

Create a value of AccountGateResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:AccountGateResult', accountGateResult_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.

$sel:statusReason:AccountGateResult', accountGateResult_statusReason - The reason for the account gate status assigned to this account and Region for the stack set operation.

accountGateResult_status :: Lens' AccountGateResult (Maybe 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.

accountGateResult_statusReason :: Lens' AccountGateResult (Maybe Text)

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