Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudFormation.Types.AccountGateResult

Description

Documentation

data AccountGateResult Source #

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 does not 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 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 has not 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 adminstration 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

Instances details

Eq AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult Methods (==) :: AccountGateResult -> AccountGateResult -> Bool # (/=) :: AccountGateResult -> AccountGateResult -> Bool #
Read AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult Methods readsPrec :: Int -> ReadS AccountGateResult # readList :: ReadS [AccountGateResult] # readPrec :: ReadPrec AccountGateResult # readListPrec :: ReadPrec [AccountGateResult] #
Show AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult Methods showsPrec :: Int -> AccountGateResult -> ShowS # show :: AccountGateResult -> String # showList :: [AccountGateResult] -> ShowS #
Generic AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult Associated Types type Rep AccountGateResult :: Type -> Type # Methods from :: AccountGateResult -> Rep AccountGateResult x # to :: Rep AccountGateResult x -> AccountGateResult #
NFData AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult Methods rnf :: AccountGateResult -> () #
Hashable AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult Methods hashWithSalt :: Int -> AccountGateResult -> Int # hash :: AccountGateResult -> Int #
FromXML AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult Methods parseXML :: [Node] -> Either String AccountGateResult #
type Rep AccountGateResult Source #
Instance details Defined in Amazonka.CloudFormation.Types.AccountGateResult type Rep AccountGateResult = D1 ('MetaData "AccountGateResult" "Amazonka.CloudFormation.Types.AccountGateResult" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" '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 Source #

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 does not 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 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 has not 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 adminstration 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) Source #

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 does not 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 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 has not 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 adminstration 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) Source #

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