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

Description

Documentation

data StackSetOperationSummary Source #

The structures that contain summary information about the specified operation.

See: newStackSetOperationSummary smart constructor.

Constructors

StackSetOperationSummary'

Fields

status :: Maybe StackSetOperationStatus
The overall status of the operation.
- FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
- QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
- RUNNING: The operation is currently being performed.
- STOPPED: The user has cancelled the operation.
- STOPPING: The operation is in the process of stopping, at user request.
- SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
action :: Maybe StackSetOperationAction
The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.
endTimestamp :: Maybe ISO8601
The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
creationTimestamp :: Maybe ISO8601
The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
operationId :: Maybe Text
The unique ID of the stack set operation.

Instances

Instances details

Eq StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary Methods (==) :: StackSetOperationSummary -> StackSetOperationSummary -> Bool # (/=) :: StackSetOperationSummary -> StackSetOperationSummary -> Bool #
Read StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary Methods readsPrec :: Int -> ReadS StackSetOperationSummary # readList :: ReadS [StackSetOperationSummary] # readPrec :: ReadPrec StackSetOperationSummary # readListPrec :: ReadPrec [StackSetOperationSummary] #
Show StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary Methods showsPrec :: Int -> StackSetOperationSummary -> ShowS # show :: StackSetOperationSummary -> String # showList :: [StackSetOperationSummary] -> ShowS #
Generic StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary Associated Types type Rep StackSetOperationSummary :: Type -> Type # Methods from :: StackSetOperationSummary -> Rep StackSetOperationSummary x # to :: Rep StackSetOperationSummary x -> StackSetOperationSummary #
NFData StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary Methods rnf :: StackSetOperationSummary -> () #
Hashable StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary Methods hashWithSalt :: Int -> StackSetOperationSummary -> Int # hash :: StackSetOperationSummary -> Int #
FromXML StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary Methods parseXML :: [Node] -> Either String StackSetOperationSummary #
type Rep StackSetOperationSummary Source #
Instance details Defined in Amazonka.CloudFormation.Types.StackSetOperationSummary type Rep StackSetOperationSummary = D1 ('MetaData "StackSetOperationSummary" "Amazonka.CloudFormation.Types.StackSetOperationSummary" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "StackSetOperationSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationStatus)) :: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationAction))) :: (S1 ('MetaSel ('Just "endTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newStackSetOperationSummary :: StackSetOperationSummary Source #

Create a value of StackSetOperationSummary 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:StackSetOperationSummary', stackSetOperationSummary_status - The overall status of the operation.

FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

$sel:action:StackSetOperationSummary', stackSetOperationSummary_action - The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.

$sel:endTimestamp:StackSetOperationSummary', stackSetOperationSummary_endTimestamp - The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

$sel:creationTimestamp:StackSetOperationSummary', stackSetOperationSummary_creationTimestamp - The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

$sel:operationId:StackSetOperationSummary', stackSetOperationSummary_operationId - The unique ID of the stack set operation.

stackSetOperationSummary_status :: Lens' StackSetOperationSummary (Maybe StackSetOperationStatus) Source #

The overall status of the operation.

FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

stackSetOperationSummary_action :: Lens' StackSetOperationSummary (Maybe StackSetOperationAction) Source #

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.

stackSetOperationSummary_endTimestamp :: Lens' StackSetOperationSummary (Maybe UTCTime) Source #

The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

stackSetOperationSummary_creationTimestamp :: Lens' StackSetOperationSummary (Maybe UTCTime) Source #

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

stackSetOperationSummary_operationId :: Lens' StackSetOperationSummary (Maybe Text) Source #

The unique ID of the stack set operation.