amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.Types.StackSetOperationResultSummary

Description

 
Synopsis

Documentation

data StackSetOperationResultSummary Source #

The structure that contains information about a specified operation's results for a given account in a given Region.

See: newStackSetOperationResultSummary smart constructor.

Constructors

StackSetOperationResultSummary' 

Fields

  • account :: Maybe Text
    Self-managed permissions
    The name of the Amazon Web Services account for this operation result.
  • accountGateResult :: Maybe AccountGateResult

    The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.

  • organizationalUnitId :: Maybe Text
    Service-managed permissions
    The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
  • region :: Maybe Text

    The name of the Amazon Web Services Region for this operation result.

  • status :: Maybe StackSetOperationResultStatus

    The result status of the stack set operation for the given account in the given Region.

    • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
    • FAILED: The operation in the specified account and Region failed.

      If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

    • RUNNING: The operation in the specified account and Region is currently in progress.
    • PENDING: The operation in the specified account and Region has yet to start.
    • SUCCEEDED: The operation in the specified account and Region completed successfully.
  • statusReason :: Maybe Text

    The reason for the assigned result status.

Instances

Instances details
FromXML StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

Generic StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

Associated Types

type Rep StackSetOperationResultSummary :: Type -> Type #

Read StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

Show StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

NFData StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

Eq StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

Hashable StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

type Rep StackSetOperationResultSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackSetOperationResultSummary

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

newStackSetOperationResultSummary :: StackSetOperationResultSummary Source #

Create a value of StackSetOperationResultSummary 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:account:StackSetOperationResultSummary', stackSetOperationResultSummary_account - [Self-managed permissions] The name of the Amazon Web Services account for this operation result.

$sel:accountGateResult:StackSetOperationResultSummary', stackSetOperationResultSummary_accountGateResult - The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.

$sel:organizationalUnitId:StackSetOperationResultSummary', stackSetOperationResultSummary_organizationalUnitId - [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

$sel:region:StackSetOperationResultSummary', stackSetOperationResultSummary_region - The name of the Amazon Web Services Region for this operation result.

StackSetOperationResultSummary, stackSetOperationResultSummary_status - The result status of the stack set operation for the given account in the given Region.

  • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
  • FAILED: The operation in the specified account and Region failed.

    If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

  • RUNNING: The operation in the specified account and Region is currently in progress.
  • PENDING: The operation in the specified account and Region has yet to start.
  • SUCCEEDED: The operation in the specified account and Region completed successfully.

StackSetOperationResultSummary, stackSetOperationResultSummary_statusReason - The reason for the assigned result status.

stackSetOperationResultSummary_account :: Lens' StackSetOperationResultSummary (Maybe Text) Source #

Self-managed permissions
The name of the Amazon Web Services account for this operation result.

stackSetOperationResultSummary_accountGateResult :: Lens' StackSetOperationResultSummary (Maybe AccountGateResult) Source #

The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.

stackSetOperationResultSummary_organizationalUnitId :: Lens' StackSetOperationResultSummary (Maybe Text) Source #

Service-managed permissions
The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

stackSetOperationResultSummary_region :: Lens' StackSetOperationResultSummary (Maybe Text) Source #

The name of the Amazon Web Services Region for this operation result.

stackSetOperationResultSummary_status :: Lens' StackSetOperationResultSummary (Maybe StackSetOperationResultStatus) Source #

The result status of the stack set operation for the given account in the given Region.

  • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
  • FAILED: The operation in the specified account and Region failed.

    If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

  • RUNNING: The operation in the specified account and Region is currently in progress.
  • PENDING: The operation in the specified account and Region has yet to start.
  • SUCCEEDED: The operation in the specified account and Region completed successfully.