| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.CloudFormation.Types
Contents
- Service Configuration
- Errors
- AccountGateStatus
- Capability
- ChangeAction
- ChangeSetStatus
- ChangeSetType
- ChangeSource
- ChangeType
- EvaluationType
- ExecutionStatus
- OnFailure
- Replacement
- RequiresRecreation
- ResourceAttribute
- ResourceSignalStatus
- ResourceStatus
- StackInstanceStatus
- StackSetOperationAction
- StackSetOperationResultStatus
- StackSetOperationStatus
- StackSetStatus
- StackStatus
- TemplateStage
- AccountGateResult
- AccountLimit
- Change
- ChangeSetSummary
- Export
- Output
- Parameter
- ParameterConstraints
- ParameterDeclaration
- ResourceChange
- ResourceChangeDetail
- ResourceTargetDefinition
- RollbackConfiguration
- RollbackTrigger
- Stack
- StackEvent
- StackInstance
- StackInstanceSummary
- StackResource
- StackResourceDetail
- StackResourceSummary
- StackSet
- StackSetOperation
- StackSetOperationPreferences
- StackSetOperationResultSummary
- StackSetOperationSummary
- StackSetSummary
- StackSummary
- Tag
- TemplateParameter
Description
- cloudFormation :: Service
- _CreatedButModifiedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ChangeSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidChangeSetStatusException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationIdAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientCapabilitiesException :: AsError a => Getting (First ServiceError) a ServiceError
- _TokenAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _StackSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _StackInstanceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _StackSetNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _NameAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _StaleRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data AccountGateStatus
- data Capability
- data ChangeAction
- data ChangeSetStatus
- data ChangeSetType
- data ChangeSource
- data ChangeType = Resource
- data EvaluationType
- data ExecutionStatus
- data OnFailure
- data Replacement
- = Conditional
- | False'
- | True'
- data RequiresRecreation
- = Always
- | Conditionally
- | Never
- data ResourceAttribute
- data ResourceSignalStatus
- data ResourceStatus
- data StackInstanceStatus
- data StackSetOperationAction
- data StackSetOperationResultStatus
- data StackSetOperationStatus
- data StackSetStatus
- data StackStatus
- = SSCreateComplete
- | SSCreateFailed
- | SSCreateInProgress
- | SSDeleteComplete
- | SSDeleteFailed
- | SSDeleteInProgress
- | SSReviewInProgress
- | SSRollbackComplete
- | SSRollbackFailed
- | SSRollbackInProgress
- | SSUpdateComplete
- | SSUpdateCompleteCleanupInProgress
- | SSUpdateInProgress
- | SSUpdateRollbackComplete
- | SSUpdateRollbackCompleteCleanupInProgress
- | SSUpdateRollbackFailed
- | SSUpdateRollbackInProgress
- data TemplateStage
- data AccountGateResult
- accountGateResult :: AccountGateResult
- agrStatus :: Lens' AccountGateResult (Maybe AccountGateStatus)
- agrStatusReason :: Lens' AccountGateResult (Maybe Text)
- data AccountLimit
- accountLimit :: AccountLimit
- alValue :: Lens' AccountLimit (Maybe Int)
- alName :: Lens' AccountLimit (Maybe Text)
- data Change
- change :: Change
- cResourceChange :: Lens' Change (Maybe ResourceChange)
- cType :: Lens' Change (Maybe ChangeType)
- data ChangeSetSummary
- changeSetSummary :: ChangeSetSummary
- cCreationTime :: Lens' ChangeSetSummary (Maybe UTCTime)
- cStatus :: Lens' ChangeSetSummary (Maybe ChangeSetStatus)
- cChangeSetName :: Lens' ChangeSetSummary (Maybe Text)
- cExecutionStatus :: Lens' ChangeSetSummary (Maybe ExecutionStatus)
- cChangeSetId :: Lens' ChangeSetSummary (Maybe Text)
- cStatusReason :: Lens' ChangeSetSummary (Maybe Text)
- cStackId :: Lens' ChangeSetSummary (Maybe Text)
- cDescription :: Lens' ChangeSetSummary (Maybe Text)
- cStackName :: Lens' ChangeSetSummary (Maybe Text)
- data Export
- export' :: Export
- eValue :: Lens' Export (Maybe Text)
- eExportingStackId :: Lens' Export (Maybe Text)
- eName :: Lens' Export (Maybe Text)
- data Output
- output :: Output
- oOutputValue :: Lens' Output (Maybe Text)
- oOutputKey :: Lens' Output (Maybe Text)
- oExportName :: Lens' Output (Maybe Text)
- oDescription :: Lens' Output (Maybe Text)
- data Parameter
- parameter :: Parameter
- pParameterValue :: Lens' Parameter (Maybe Text)
- pResolvedValue :: Lens' Parameter (Maybe Text)
- pParameterKey :: Lens' Parameter (Maybe Text)
- pUsePreviousValue :: Lens' Parameter (Maybe Bool)
- data ParameterConstraints
- parameterConstraints :: ParameterConstraints
- pcAllowedValues :: Lens' ParameterConstraints [Text]
- data ParameterDeclaration
- parameterDeclaration :: ParameterDeclaration
- pdParameterKey :: Lens' ParameterDeclaration (Maybe Text)
- pdParameterType :: Lens' ParameterDeclaration (Maybe Text)
- pdParameterConstraints :: Lens' ParameterDeclaration (Maybe ParameterConstraints)
- pdDefaultValue :: Lens' ParameterDeclaration (Maybe Text)
- pdNoEcho :: Lens' ParameterDeclaration (Maybe Bool)
- pdDescription :: Lens' ParameterDeclaration (Maybe Text)
- data ResourceChange
- resourceChange :: ResourceChange
- rcLogicalResourceId :: Lens' ResourceChange (Maybe Text)
- rcPhysicalResourceId :: Lens' ResourceChange (Maybe Text)
- rcResourceType :: Lens' ResourceChange (Maybe Text)
- rcAction :: Lens' ResourceChange (Maybe ChangeAction)
- rcScope :: Lens' ResourceChange [ResourceAttribute]
- rcDetails :: Lens' ResourceChange [ResourceChangeDetail]
- rcReplacement :: Lens' ResourceChange (Maybe Replacement)
- data ResourceChangeDetail
- resourceChangeDetail :: ResourceChangeDetail
- rcdCausingEntity :: Lens' ResourceChangeDetail (Maybe Text)
- rcdChangeSource :: Lens' ResourceChangeDetail (Maybe ChangeSource)
- rcdEvaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType)
- rcdTarget :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition)
- data ResourceTargetDefinition
- resourceTargetDefinition :: ResourceTargetDefinition
- rtdAttribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute)
- rtdRequiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation)
- rtdName :: Lens' ResourceTargetDefinition (Maybe Text)
- data RollbackConfiguration
- rollbackConfiguration :: RollbackConfiguration
- rcRollbackTriggers :: Lens' RollbackConfiguration [RollbackTrigger]
- rcMonitoringTimeInMinutes :: Lens' RollbackConfiguration (Maybe Natural)
- data RollbackTrigger
- rollbackTrigger :: Text -> Text -> RollbackTrigger
- rtARN :: Lens' RollbackTrigger Text
- rtType :: Lens' RollbackTrigger Text
- data Stack
- stack :: Text -> UTCTime -> StackStatus -> Stack
- sDisableRollback :: Lens' Stack (Maybe Bool)
- sLastUpdatedTime :: Lens' Stack (Maybe UTCTime)
- sRootId :: Lens' Stack (Maybe Text)
- sNotificationARNs :: Lens' Stack [Text]
- sStackStatusReason :: Lens' Stack (Maybe Text)
- sEnableTerminationProtection :: Lens' Stack (Maybe Bool)
- sChangeSetId :: Lens' Stack (Maybe Text)
- sDeletionTime :: Lens' Stack (Maybe UTCTime)
- sOutputs :: Lens' Stack [Output]
- sParameters :: Lens' Stack [Parameter]
- sStackId :: Lens' Stack (Maybe Text)
- sDescription :: Lens' Stack (Maybe Text)
- sCapabilities :: Lens' Stack [Capability]
- sRollbackConfiguration :: Lens' Stack (Maybe RollbackConfiguration)
- sTags :: Lens' Stack [Tag]
- sTimeoutInMinutes :: Lens' Stack (Maybe Natural)
- sParentId :: Lens' Stack (Maybe Text)
- sRoleARN :: Lens' Stack (Maybe Text)
- sStackName :: Lens' Stack Text
- sCreationTime :: Lens' Stack UTCTime
- sStackStatus :: Lens' Stack StackStatus
- data StackEvent
- stackEvent :: Text -> Text -> Text -> UTCTime -> StackEvent
- seLogicalResourceId :: Lens' StackEvent (Maybe Text)
- sePhysicalResourceId :: Lens' StackEvent (Maybe Text)
- seResourceType :: Lens' StackEvent (Maybe Text)
- seResourceStatusReason :: Lens' StackEvent (Maybe Text)
- seResourceProperties :: Lens' StackEvent (Maybe Text)
- seResourceStatus :: Lens' StackEvent (Maybe ResourceStatus)
- seClientRequestToken :: Lens' StackEvent (Maybe Text)
- seStackId :: Lens' StackEvent Text
- seEventId :: Lens' StackEvent Text
- seStackName :: Lens' StackEvent Text
- seTimestamp :: Lens' StackEvent UTCTime
- data StackInstance
- stackInstance :: StackInstance
- siStatus :: Lens' StackInstance (Maybe StackInstanceStatus)
- siAccount :: Lens' StackInstance (Maybe Text)
- siRegion :: Lens' StackInstance (Maybe Text)
- siStatusReason :: Lens' StackInstance (Maybe Text)
- siStackId :: Lens' StackInstance (Maybe Text)
- siParameterOverrides :: Lens' StackInstance [Parameter]
- siStackSetId :: Lens' StackInstance (Maybe Text)
- data StackInstanceSummary
- stackInstanceSummary :: StackInstanceSummary
- sisStatus :: Lens' StackInstanceSummary (Maybe StackInstanceStatus)
- sisAccount :: Lens' StackInstanceSummary (Maybe Text)
- sisRegion :: Lens' StackInstanceSummary (Maybe Text)
- sisStatusReason :: Lens' StackInstanceSummary (Maybe Text)
- sisStackId :: Lens' StackInstanceSummary (Maybe Text)
- sisStackSetId :: Lens' StackInstanceSummary (Maybe Text)
- data StackResource
- stackResource :: Text -> Text -> UTCTime -> ResourceStatus -> StackResource
- srPhysicalResourceId :: Lens' StackResource (Maybe Text)
- srResourceStatusReason :: Lens' StackResource (Maybe Text)
- srStackId :: Lens' StackResource (Maybe Text)
- srDescription :: Lens' StackResource (Maybe Text)
- srStackName :: Lens' StackResource (Maybe Text)
- srLogicalResourceId :: Lens' StackResource Text
- srResourceType :: Lens' StackResource Text
- srTimestamp :: Lens' StackResource UTCTime
- srResourceStatus :: Lens' StackResource ResourceStatus
- data StackResourceDetail
- stackResourceDetail :: Text -> Text -> UTCTime -> ResourceStatus -> StackResourceDetail
- srdPhysicalResourceId :: Lens' StackResourceDetail (Maybe Text)
- srdResourceStatusReason :: Lens' StackResourceDetail (Maybe Text)
- srdMetadata :: Lens' StackResourceDetail (Maybe Text)
- srdStackId :: Lens' StackResourceDetail (Maybe Text)
- srdDescription :: Lens' StackResourceDetail (Maybe Text)
- srdStackName :: Lens' StackResourceDetail (Maybe Text)
- srdLogicalResourceId :: Lens' StackResourceDetail Text
- srdResourceType :: Lens' StackResourceDetail Text
- srdLastUpdatedTimestamp :: Lens' StackResourceDetail UTCTime
- srdResourceStatus :: Lens' StackResourceDetail ResourceStatus
- data StackResourceSummary
- stackResourceSummary :: Text -> Text -> UTCTime -> ResourceStatus -> StackResourceSummary
- srsPhysicalResourceId :: Lens' StackResourceSummary (Maybe Text)
- srsResourceStatusReason :: Lens' StackResourceSummary (Maybe Text)
- srsLogicalResourceId :: Lens' StackResourceSummary Text
- srsResourceType :: Lens' StackResourceSummary Text
- srsLastUpdatedTimestamp :: Lens' StackResourceSummary UTCTime
- srsResourceStatus :: Lens' StackResourceSummary ResourceStatus
- data StackSet
- stackSet :: StackSet
- ssStatus :: Lens' StackSet (Maybe StackSetStatus)
- ssAdministrationRoleARN :: Lens' StackSet (Maybe Text)
- ssStackSetARN :: Lens' StackSet (Maybe Text)
- ssParameters :: Lens' StackSet [Parameter]
- ssTemplateBody :: Lens' StackSet (Maybe Text)
- ssStackSetName :: Lens' StackSet (Maybe Text)
- ssDescription :: Lens' StackSet (Maybe Text)
- ssCapabilities :: Lens' StackSet [Capability]
- ssTags :: Lens' StackSet [Tag]
- ssStackSetId :: Lens' StackSet (Maybe Text)
- data StackSetOperation
- stackSetOperation :: StackSetOperation
- ssoStatus :: Lens' StackSetOperation (Maybe StackSetOperationStatus)
- ssoAdministrationRoleARN :: Lens' StackSetOperation (Maybe Text)
- ssoAction :: Lens' StackSetOperation (Maybe StackSetOperationAction)
- ssoEndTimestamp :: Lens' StackSetOperation (Maybe UTCTime)
- ssoCreationTimestamp :: Lens' StackSetOperation (Maybe UTCTime)
- ssoOperationPreferences :: Lens' StackSetOperation (Maybe StackSetOperationPreferences)
- ssoOperationId :: Lens' StackSetOperation (Maybe Text)
- ssoRetainStacks :: Lens' StackSetOperation (Maybe Bool)
- ssoStackSetId :: Lens' StackSetOperation (Maybe Text)
- data StackSetOperationPreferences
- stackSetOperationPreferences :: StackSetOperationPreferences
- ssopRegionOrder :: Lens' StackSetOperationPreferences [Text]
- ssopMaxConcurrentCount :: Lens' StackSetOperationPreferences (Maybe Natural)
- ssopMaxConcurrentPercentage :: Lens' StackSetOperationPreferences (Maybe Natural)
- ssopFailureToleranceCount :: Lens' StackSetOperationPreferences (Maybe Natural)
- ssopFailureTolerancePercentage :: Lens' StackSetOperationPreferences (Maybe Natural)
- data StackSetOperationResultSummary
- stackSetOperationResultSummary :: StackSetOperationResultSummary
- ssorsStatus :: Lens' StackSetOperationResultSummary (Maybe StackSetOperationResultStatus)
- ssorsAccount :: Lens' StackSetOperationResultSummary (Maybe Text)
- ssorsAccountGateResult :: Lens' StackSetOperationResultSummary (Maybe AccountGateResult)
- ssorsRegion :: Lens' StackSetOperationResultSummary (Maybe Text)
- ssorsStatusReason :: Lens' StackSetOperationResultSummary (Maybe Text)
- data StackSetOperationSummary
- stackSetOperationSummary :: StackSetOperationSummary
- ssosStatus :: Lens' StackSetOperationSummary (Maybe StackSetOperationStatus)
- ssosAction :: Lens' StackSetOperationSummary (Maybe StackSetOperationAction)
- ssosEndTimestamp :: Lens' StackSetOperationSummary (Maybe UTCTime)
- ssosCreationTimestamp :: Lens' StackSetOperationSummary (Maybe UTCTime)
- ssosOperationId :: Lens' StackSetOperationSummary (Maybe Text)
- data StackSetSummary
- stackSetSummary :: StackSetSummary
- sssStatus :: Lens' StackSetSummary (Maybe StackSetStatus)
- sssStackSetName :: Lens' StackSetSummary (Maybe Text)
- sssDescription :: Lens' StackSetSummary (Maybe Text)
- sssStackSetId :: Lens' StackSetSummary (Maybe Text)
- data StackSummary
- stackSummary :: Text -> UTCTime -> StackStatus -> StackSummary
- ssLastUpdatedTime :: Lens' StackSummary (Maybe UTCTime)
- ssRootId :: Lens' StackSummary (Maybe Text)
- ssStackStatusReason :: Lens' StackSummary (Maybe Text)
- ssTemplateDescription :: Lens' StackSummary (Maybe Text)
- ssDeletionTime :: Lens' StackSummary (Maybe UTCTime)
- ssStackId :: Lens' StackSummary (Maybe Text)
- ssParentId :: Lens' StackSummary (Maybe Text)
- ssStackName :: Lens' StackSummary Text
- ssCreationTime :: Lens' StackSummary UTCTime
- ssStackStatus :: Lens' StackSummary StackStatus
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data TemplateParameter
- templateParameter :: TemplateParameter
- tpParameterKey :: Lens' TemplateParameter (Maybe Text)
- tpDefaultValue :: Lens' TemplateParameter (Maybe Text)
- tpNoEcho :: Lens' TemplateParameter (Maybe Bool)
- tpDescription :: Lens' TemplateParameter (Maybe Text)
Service Configuration
cloudFormation :: Service Source #
API version 2010-05-15 of the Amazon CloudFormation SDK configuration.
Errors
_CreatedButModifiedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource exists, but has been changed.
_ChangeSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.
_OperationInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.
_InvalidChangeSetStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS , or the stack status might be UPDATE_IN_PROGRESS .
_OperationNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified ID refers to an operation that doesn't exist.
_OperationIdAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified operation ID already exists.
_InsufficientCapabilitiesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The template contains resources with capabilities that weren't specified in the Capabilities parameter.
_TokenAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A client request token already exists.
_StackSetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified stack set doesn't exist.
_StackInstanceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified stack instance doesn't exist.
_StackSetNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.
_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified operation isn't valid.
_NameAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified name is already in use.
_StaleRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another operation has been performed on this stack set since the specified operation was performed.
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource with the name requested already exists.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota for the resource has already been reached.
For information on stack set limitations, see Limitations of StackSets .
AccountGateStatus
data AccountGateStatus Source #
Constructors
| AGSFailed | |
| AGSSkipped | |
| AGSSucceeded |
Instances
Capability
data Capability Source #
Constructors
| CapabilityIAM | |
| CapabilityNamedIAM |
Instances
ChangeAction
data ChangeAction Source #
Instances
ChangeSetStatus
data ChangeSetStatus Source #
Instances
ChangeSetType
data ChangeSetType Source #
Instances
ChangeSource
data ChangeSource Source #
Instances
ChangeType
data ChangeType Source #
Constructors
| Resource |
Instances
EvaluationType
data EvaluationType Source #
Instances
ExecutionStatus
data ExecutionStatus Source #
Instances
OnFailure
Instances
Replacement
data Replacement Source #
Constructors
| Conditional | |
| False' | |
| True' |
Instances
RequiresRecreation
data RequiresRecreation Source #
Constructors
| Always | |
| Conditionally | |
| Never |
Instances
ResourceAttribute
data ResourceAttribute Source #
Constructors
| CreationPolicy | |
| DeletionPolicy | |
| Metadata | |
| Properties | |
| Tags | |
| UpdatePolicy |
Instances
ResourceSignalStatus
data ResourceSignalStatus Source #
Instances
ResourceStatus
data ResourceStatus Source #
Constructors
| CreateComplete | |
| CreateFailed | |
| CreateInProgress | |
| DeleteComplete | |
| DeleteFailed | |
| DeleteInProgress | |
| DeleteSkipped | |
| UpdateComplete | |
| UpdateFailed | |
| UpdateInProgress |
Instances
StackInstanceStatus
data StackInstanceStatus Source #
Constructors
| Current | |
| Inoperable | |
| Outdated |
Instances
StackSetOperationAction
data StackSetOperationAction Source #
Constructors
| SSOACreate | |
| SSOADelete | |
| SSOAUpdate |
Instances
StackSetOperationResultStatus
data StackSetOperationResultStatus Source #
Instances
StackSetOperationStatus
data StackSetOperationStatus Source #
Constructors
| SSOSFailed | |
| SSOSRunning | |
| SSOSStopped | |
| SSOSStopping | |
| SSOSSucceeded |
Instances
StackSetStatus
data StackSetStatus Source #
Instances
StackStatus
data StackStatus Source #
Constructors
Instances
TemplateStage
data TemplateStage Source #
Instances
AccountGateResult
data AccountGateResult Source #
Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.
For each account and region, AWS CloudFormation lets you specify a Lamdba 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: accountGateResult smart constructor.
Instances
accountGateResult :: AccountGateResult Source #
Creates a value of AccountGateResult with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
agrStatus- 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. AWS 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 toFAILED. *SKIPPED: AWS 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. AWS CloudFormation proceeds with the stack set operation in this account and region. * TheAWSCloudFormationStackSetExecutionRoleof the stack set adminstration account lacks permissions to invoke the function. AWS 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. AWS CloudFormation skips the stack set operation in this account and region.agrStatusReason- The reason for the account gate status assigned to this account and region for the stack set operation.
agrStatus :: 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. AWS 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 : AWS 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. AWS 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. AWS 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. AWS CloudFormation skips the stack set operation in this account and region.
agrStatusReason :: Lens' AccountGateResult (Maybe Text) Source #
The reason for the account gate status assigned to this account and region for the stack set operation.
AccountLimit
data AccountLimit Source #
The AccountLimit data type.
See: accountLimit smart constructor.
accountLimit :: AccountLimit Source #
Creates a value of AccountLimit with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alValue :: Lens' AccountLimit (Maybe Int) Source #
The value that is associated with the account limit name.
alName :: Lens' AccountLimit (Maybe Text) Source #
The name of the account limit. Currently, the only account limit is StackLimit .
Change
The Change structure describes the changes AWS CloudFormation will perform if you execute the change set.
See: change smart constructor.
Creates a value of Change with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cResourceChange- AResourceChangestructure that describes the resource and action that AWS CloudFormation will perform.cType- The type of entity that AWS CloudFormation changes. Currently, the only entity type isResource.
cResourceChange :: Lens' Change (Maybe ResourceChange) Source #
A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.
cType :: Lens' Change (Maybe ChangeType) Source #
The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource .
ChangeSetSummary
data ChangeSetSummary Source #
The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.
See: changeSetSummary smart constructor.
Instances
changeSetSummary :: ChangeSetSummary Source #
Creates a value of ChangeSetSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cCreationTime- The start time when the change set was created, in UTC.cStatus- The state of the change set, such asCREATE_IN_PROGRESS,CREATE_COMPLETE, orFAILED.cChangeSetName- The name of the change set.cExecutionStatus- If the change set execution status isAVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLEstate because AWS CloudFormation is still creating it or in anOBSOLETEstate because the stack was already updated.cChangeSetId- The ID of the change set.cStatusReason- A description of the change set's status. For example, if your change set is in theFAILEDstate, AWS CloudFormation shows the error message.cStackId- The ID of the stack with which the change set is associated.cDescription- Descriptive information about the change set.cStackName- The name of the stack with which the change set is associated.
cCreationTime :: Lens' ChangeSetSummary (Maybe UTCTime) Source #
The start time when the change set was created, in UTC.
cStatus :: Lens' ChangeSetSummary (Maybe ChangeSetStatus) Source #
The state of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or FAILED .
cChangeSetName :: Lens' ChangeSetSummary (Maybe Text) Source #
The name of the change set.
cExecutionStatus :: Lens' ChangeSetSummary (Maybe ExecutionStatus) Source #
If the change set execution status is AVAILABLE , you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
cChangeSetId :: Lens' ChangeSetSummary (Maybe Text) Source #
The ID of the change set.
cStatusReason :: Lens' ChangeSetSummary (Maybe Text) Source #
A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message.
cStackId :: Lens' ChangeSetSummary (Maybe Text) Source #
The ID of the stack with which the change set is associated.
cDescription :: Lens' ChangeSetSummary (Maybe Text) Source #
Descriptive information about the change set.
cStackName :: Lens' ChangeSetSummary (Maybe Text) Source #
The name of the stack with which the change set is associated.
Export
The Export structure describes the exported output values for a stack.
See: export' smart constructor.
Creates a value of Export with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eValue- The value of the exported output, such as a resource physical ID. This value is defined in theExportfield in the associated stack'sOutputssection.eExportingStackId- The stack that contains the exported output name and value.eName- The name of exported output value. Use this name and theFn::ImportValuefunction to import the associated value into other stacks. The name is defined in theExportfield in the associated stack'sOutputssection.
eValue :: Lens' Export (Maybe Text) Source #
The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.
eExportingStackId :: Lens' Export (Maybe Text) Source #
The stack that contains the exported output name and value.
eName :: Lens' Export (Maybe Text) Source #
The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.
Output
The Output data type.
See: output smart constructor.
Creates a value of Output with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oOutputValue- The value associated with the output.oOutputKey- The key associated with the output.oExportName- The name of the export associated with the output.oDescription- User defined description associated with the output.
oDescription :: Lens' Output (Maybe Text) Source #
User defined description associated with the output.
Parameter
The Parameter data type.
See: parameter smart constructor.
parameter :: Parameter Source #
Creates a value of Parameter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pParameterValue- The input value associated with the parameter.pResolvedValue- Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for @SSM@ parameter types in the template.pParameterKey- The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.pUsePreviousValue- During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specifytrue, do not specify a parameter value.
pParameterValue :: Lens' Parameter (Maybe Text) Source #
The input value associated with the parameter.
pResolvedValue :: Lens' Parameter (Maybe Text) Source #
Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for @SSM@ parameter types in the template.
pParameterKey :: Lens' Parameter (Maybe Text) Source #
The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
pUsePreviousValue :: Lens' Parameter (Maybe Bool) Source #
During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true , do not specify a parameter value.
ParameterConstraints
data ParameterConstraints Source #
A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.
See: parameterConstraints smart constructor.
Instances
parameterConstraints :: ParameterConstraints Source #
Creates a value of ParameterConstraints with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcAllowedValues- A list of values that are permitted for a parameter.
pcAllowedValues :: Lens' ParameterConstraints [Text] Source #
A list of values that are permitted for a parameter.
ParameterDeclaration
data ParameterDeclaration Source #
The ParameterDeclaration data type.
See: parameterDeclaration smart constructor.
Instances
parameterDeclaration :: ParameterDeclaration Source #
Creates a value of ParameterDeclaration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdParameterKey- The name that is associated with the parameter.pdParameterType- The type of parameter.pdParameterConstraints- The criteria that AWS CloudFormation uses to validate parameter values.pdDefaultValue- The default value of the parameter.pdNoEcho- Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.pdDescription- The description that is associate with the parameter.
pdParameterKey :: Lens' ParameterDeclaration (Maybe Text) Source #
The name that is associated with the parameter.
pdParameterType :: Lens' ParameterDeclaration (Maybe Text) Source #
The type of parameter.
pdParameterConstraints :: Lens' ParameterDeclaration (Maybe ParameterConstraints) Source #
The criteria that AWS CloudFormation uses to validate parameter values.
pdDefaultValue :: Lens' ParameterDeclaration (Maybe Text) Source #
The default value of the parameter.
pdNoEcho :: Lens' ParameterDeclaration (Maybe Bool) Source #
Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
pdDescription :: Lens' ParameterDeclaration (Maybe Text) Source #
The description that is associate with the parameter.
ResourceChange
data ResourceChange Source #
The ResourceChange structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.
See: resourceChange smart constructor.
resourceChange :: ResourceChange Source #
Creates a value of ResourceChange with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcLogicalResourceId- The resource's logical ID, which is defined in the stack's template.rcPhysicalResourceId- The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.rcResourceType- The type of AWS CloudFormation resource, such asAWS::S3::Bucket.rcAction- The action that AWS CloudFormation takes on the resource, such asAdd(adds a new resource),Modify(changes a resource), orRemove(deletes a resource).rcScope- For theModifyaction, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata,Properties, orTags.rcDetails- For theModifyaction, a list ofResourceChangeDetailstructures that describes the changes that AWS CloudFormation will make to the resource.rcReplacement- For theModifyaction, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreationproperty in theResourceTargetDefinitionstructure. For example, if theRequiresRecreationfield isAlwaysand theEvaluationfield isStatic,ReplacementisTrue. If theRequiresRecreationfield isAlwaysand theEvaluationfield isDynamic,ReplacementisConditionally. If you have multiple changes with differentRequiresRecreationvalues, theReplacementvalue depends on the change with the most impact. ARequiresRecreationvalue ofAlwayshas the most impact, followed byConditionally, and thenNever.
rcLogicalResourceId :: Lens' ResourceChange (Maybe Text) Source #
The resource's logical ID, which is defined in the stack's template.
rcPhysicalResourceId :: Lens' ResourceChange (Maybe Text) Source #
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
rcResourceType :: Lens' ResourceChange (Maybe Text) Source #
The type of AWS CloudFormation resource, such as AWS::S3::Bucket .
rcAction :: Lens' ResourceChange (Maybe ChangeAction) Source #
The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).
rcScope :: Lens' ResourceChange [ResourceAttribute] Source #
For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata , Properties , or Tags .
rcDetails :: Lens' ResourceChange [ResourceChangeDetail] Source #
For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
rcReplacement :: Lens' ResourceChange (Maybe Replacement) Source #
For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static , Replacement is True . If the RequiresRecreation field is Always and the Evaluation field is Dynamic , Replacement is Conditionally . If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally , and then Never .
ResourceChangeDetail
data ResourceChangeDetail Source #
For a resource with Modify as the action, the ResourceChange structure describes the changes AWS CloudFormation will make to that resource.
See: resourceChangeDetail smart constructor.
Instances
resourceChangeDetail :: ResourceChangeDetail Source #
Creates a value of ResourceChangeDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcdCausingEntity- The identity of the entity that triggered this change. This entity is a member of the group that is specified by theChangeSourcefield. For example, if you modified the value of theKeyPairNameparameter, theCausingEntityis the name of the parameter (KeyPairName). If theChangeSourcevalue isDirectModification, no value is given forCausingEntity.rcdChangeSource- The group to which theCausingEntityvalue belongs. There are five entity groups: *ResourceReferenceentities areRefintrinsic functions that refer to resources in the template, such as{ Ref : MyEC2InstanceResource }. *ParameterReferenceentities areRefintrinsic functions that get template parameter values, such as{ Ref : MyPasswordParameter }. *ResourceAttributeentities areFn::GetAttintrinsic functions that get resource attribute values, such as{ Fn::GetAtt : [ MyEC2InstanceResource, PublicDnsName ] }. *DirectModificationentities are changes that are made directly to the template. *Automaticentities areAWS::CloudFormation::Stackresource types, which are also known as nested stacks. If you made no changes to theAWS::CloudFormation::Stackresource, AWS CloudFormation sets theChangeSourcetoAutomaticbecause the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.rcdEvaluation- Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set. ForStaticevaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify theInstanceTypeproperty of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is aStaticevaluation. ForDynamicevaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as aReforFn::GetAttintrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.rcdTarget- AResourceTargetDefinitionstructure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
rcdCausingEntity :: Lens' ResourceChangeDetail (Maybe Text) Source #
The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName ). If the ChangeSource value is DirectModification , no value is given for CausingEntity .
rcdChangeSource :: Lens' ResourceChangeDetail (Maybe ChangeSource) Source #
The group to which the CausingEntity value belongs. There are five entity groups: * ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { Ref : MyEC2InstanceResource } . * ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { Ref : MyPasswordParameter } . * ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { Fn::GetAtt : [ MyEC2InstanceResource, PublicDnsName ] } . * DirectModification entities are changes that are made directly to the template. * Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.
rcdEvaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType) Source #
Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set. For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation. For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.
rcdTarget :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition) Source #
A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
ResourceTargetDefinition
data ResourceTargetDefinition Source #
The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.
See: resourceTargetDefinition smart constructor.
Instances
resourceTargetDefinition :: ResourceTargetDefinition Source #
Creates a value of ResourceTargetDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtdAttribute- Indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata,Properties, orTags.rtdRequiresRecreation- If theAttributevalue isProperties, indicates whether a change to this property causes the resource to be recreated. The value can beNever,Always, orConditionally. To determine the conditions for aConditionallyrecreation, see the update behavior for that property in the AWS CloudFormation User Guide.rtdName- If theAttributevalue isProperties, the name of the property. For all other attributes, the value is null.
rtdAttribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute) Source #
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata , Properties , or Tags .
rtdRequiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation) Source #
If the Attribute value is Properties , indicates whether a change to this property causes the resource to be recreated. The value can be Never , Always , or Conditionally . To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.
rtdName :: Lens' ResourceTargetDefinition (Maybe Text) Source #
If the Attribute value is Properties , the name of the property. For all other attributes, the value is null.
RollbackConfiguration
data RollbackConfiguration Source #
Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations .
See: rollbackConfiguration smart constructor.
Instances
rollbackConfiguration :: RollbackConfiguration Source #
Creates a value of RollbackConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcRollbackTriggers- The triggers to monitor during stack creation or update actions. By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means: * To use the rollback triggers previously specified for this stack, if any, don't specify this parameter. * To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack. * To remove all currently specified triggers, specify an empty list for this parameter. If a specified trigger is missing, the entire stack operation fails and is rolled back.rcMonitoringTimeInMinutes- The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. The default is 0 minutes. If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack , for example) as necessary. If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
rcRollbackTriggers :: Lens' RollbackConfiguration [RollbackTrigger] Source #
The triggers to monitor during stack creation or update actions. By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means: * To use the rollback triggers previously specified for this stack, if any, don't specify this parameter. * To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack. * To remove all currently specified triggers, specify an empty list for this parameter. If a specified trigger is missing, the entire stack operation fails and is rolled back.
rcMonitoringTimeInMinutes :: Lens' RollbackConfiguration (Maybe Natural) Source #
The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. The default is 0 minutes. If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack , for example) as necessary. If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
RollbackTrigger
data RollbackTrigger Source #
A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
See: rollbackTrigger smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RollbackTrigger |
Creates a value of RollbackTrigger with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtARN- The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger is missing, the entire stack operation fails and is rolled back.rtType- The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
rtARN :: Lens' RollbackTrigger Text Source #
The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger is missing, the entire stack operation fails and is rolled back.
rtType :: Lens' RollbackTrigger Text Source #
The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
Stack
The Stack data type.
See: stack smart constructor.
Arguments
| :: Text | |
| -> UTCTime | |
| -> StackStatus | |
| -> Stack |
Creates a value of Stack with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sDisableRollback- Boolean to enable or disable rollback on stack creation failures: *true: disable rollback *false: enable rollbacksLastUpdatedTime- The time the stack was last updated. This field will only be returned if the stack has been updated at least once.sRootId- For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .sNotificationARNs- SNS topic ARNs to which stack related events are published.sStackStatusReason- Success/failure message associated with the stack status.sEnableTerminationProtection- Whether termination protection is enabled for the stack. For nested stacks , termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide .sChangeSetId- The unique ID of the change set.sDeletionTime- The time the stack was deleted.sOutputs- A list of output structures.sParameters- A list ofParameterstructures.sStackId- Unique identifier of the stack.sDescription- A user-defined description associated with the stack.sCapabilities- The capabilities allowed in the stack.sRollbackConfiguration- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.sTags- A list ofTags that specify information about the stack.sTimeoutInMinutes- The amount of time within which stack creation should complete.sParentId- For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .sRoleARN- The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.sStackName- The name associated with the stack.sCreationTime- The time at which the stack was created.sStackStatus- Current status of the stack.
sDisableRollback :: Lens' Stack (Maybe Bool) Source #
Boolean to enable or disable rollback on stack creation failures: * true : disable rollback * false : enable rollback
sLastUpdatedTime :: Lens' Stack (Maybe UTCTime) Source #
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
sRootId :: Lens' Stack (Maybe Text) Source #
For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .
sNotificationARNs :: Lens' Stack [Text] Source #
SNS topic ARNs to which stack related events are published.
sStackStatusReason :: Lens' Stack (Maybe Text) Source #
Success/failure message associated with the stack status.
sEnableTerminationProtection :: Lens' Stack (Maybe Bool) Source #
Whether termination protection is enabled for the stack. For nested stacks , termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide .
sDescription :: Lens' Stack (Maybe Text) Source #
A user-defined description associated with the stack.
sCapabilities :: Lens' Stack [Capability] Source #
The capabilities allowed in the stack.
sRollbackConfiguration :: Lens' Stack (Maybe RollbackConfiguration) Source #
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
sTimeoutInMinutes :: Lens' Stack (Maybe Natural) Source #
The amount of time within which stack creation should complete.
sParentId :: Lens' Stack (Maybe Text) Source #
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .
sRoleARN :: Lens' Stack (Maybe Text) Source #
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
sStackStatus :: Lens' Stack StackStatus Source #
Current status of the stack.
StackEvent
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> StackEvent |
Creates a value of StackEvent with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
seLogicalResourceId- The logical name of the resource specified in the template.sePhysicalResourceId- The name or unique identifier associated with the physical instance of the resource.seResourceType- Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)seResourceStatusReason- Success/failure message associated with the resource.seResourceProperties- BLOB of the properties used to create the resource.seResourceStatus- Current status of the resource.seClientRequestToken- The token passed to the operation that generated this event. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute aCreateStackoperation with the tokentoken1, then all theStackEventsgenerated by that operation will haveClientRequestTokenset astoken1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID , which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format:Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.seStackId- The unique ID name of the instance of the stack.seEventId- The unique ID of this event.seStackName- The name associated with a stack.seTimestamp- Time the status was updated.
seLogicalResourceId :: Lens' StackEvent (Maybe Text) Source #
The logical name of the resource specified in the template.
sePhysicalResourceId :: Lens' StackEvent (Maybe Text) Source #
The name or unique identifier associated with the physical instance of the resource.
seResourceType :: Lens' StackEvent (Maybe Text) Source #
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
seResourceStatusReason :: Lens' StackEvent (Maybe Text) Source #
Success/failure message associated with the resource.
seResourceProperties :: Lens' StackEvent (Maybe Text) Source #
BLOB of the properties used to create the resource.
seResourceStatus :: Lens' StackEvent (Maybe ResourceStatus) Source #
Current status of the resource.
seClientRequestToken :: Lens' StackEvent (Maybe Text) Source #
The token passed to the operation that generated this event. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1 , then all the StackEvents generated by that operation will have ClientRequestToken set as token1 . In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID , which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 .
seStackName :: Lens' StackEvent Text Source #
The name associated with a stack.
seTimestamp :: Lens' StackEvent UTCTime Source #
Time the status was updated.
StackInstance
data StackInstance Source #
An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.
See: stackInstance smart constructor.
stackInstance :: StackInstance Source #
Creates a value of StackInstance with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siStatus- The status of the stack instance, in terms of its synchronization with its associated stack set. *INOPERABLE: ADeleteStackInstancesoperation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSetoperations. You might need to perform aDeleteStackInstancesoperation, withRetainStacksset totrue, to delete the stack instance, and then delete the stack manually. *OUTDATED: The stack isn't currently up to date with the stack set because: * The associated stack failed during aCreateStackSetorUpdateStackSetoperation. * The stack was part of aCreateStackSetorUpdateStackSetoperation that failed or was stopped before the stack was created or updated. *CURRENT: The stack is currently up to date with the stack set.siAccount- The name of the AWS account that the stack instance is associated with.siRegion- The name of the AWS region that the stack instance is associated with.siStatusReason- The explanation for the specific status code that is assigned to this stack instance.siStackId- The ID of the stack instance.siParameterOverrides- A list of parameters from the stack set template whose values have been overridden in this stack instance.siStackSetId- The name or unique ID of the stack set that the stack instance is associated with.
siStatus :: Lens' StackInstance (Maybe StackInstanceStatus) Source #
The status of the stack instance, in terms of its synchronization with its associated stack set. * INOPERABLE : A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true , to delete the stack instance, and then delete the stack manually. * OUTDATED : The stack isn't currently up to date with the stack set because: * The associated stack failed during a CreateStackSet or UpdateStackSet operation. * The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. * CURRENT : The stack is currently up to date with the stack set.
siAccount :: Lens' StackInstance (Maybe Text) Source #
The name of the AWS account that the stack instance is associated with.
siRegion :: Lens' StackInstance (Maybe Text) Source #
The name of the AWS region that the stack instance is associated with.
siStatusReason :: Lens' StackInstance (Maybe Text) Source #
The explanation for the specific status code that is assigned to this stack instance.
siParameterOverrides :: Lens' StackInstance [Parameter] Source #
A list of parameters from the stack set template whose values have been overridden in this stack instance.
siStackSetId :: Lens' StackInstance (Maybe Text) Source #
The name or unique ID of the stack set that the stack instance is associated with.
StackInstanceSummary
data StackInstanceSummary Source #
The structure that contains summary information about a stack instance.
See: stackInstanceSummary smart constructor.
Instances
stackInstanceSummary :: StackInstanceSummary Source #
Creates a value of StackInstanceSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sisStatus- The status of the stack instance, in terms of its synchronization with its associated stack set. *INOPERABLE: ADeleteStackInstancesoperation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSetoperations. You might need to perform aDeleteStackInstancesoperation, withRetainStacksset totrue, to delete the stack instance, and then delete the stack manually. *OUTDATED: The stack isn't currently up to date with the stack set because: * The associated stack failed during aCreateStackSetorUpdateStackSetoperation. * The stack was part of aCreateStackSetorUpdateStackSetoperation that failed or was stopped before the stack was created or updated. *CURRENT: The stack is currently up to date with the stack set.sisAccount- The name of the AWS account that the stack instance is associated with.sisRegion- The name of the AWS region that the stack instance is associated with.sisStatusReason- The explanation for the specific status code assigned to this stack instance.sisStackId- The ID of the stack instance.sisStackSetId- The name or unique ID of the stack set that the stack instance is associated with.
sisStatus :: Lens' StackInstanceSummary (Maybe StackInstanceStatus) Source #
The status of the stack instance, in terms of its synchronization with its associated stack set. * INOPERABLE : A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true , to delete the stack instance, and then delete the stack manually. * OUTDATED : The stack isn't currently up to date with the stack set because: * The associated stack failed during a CreateStackSet or UpdateStackSet operation. * The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. * CURRENT : The stack is currently up to date with the stack set.
sisAccount :: Lens' StackInstanceSummary (Maybe Text) Source #
The name of the AWS account that the stack instance is associated with.
sisRegion :: Lens' StackInstanceSummary (Maybe Text) Source #
The name of the AWS region that the stack instance is associated with.
sisStatusReason :: Lens' StackInstanceSummary (Maybe Text) Source #
The explanation for the specific status code assigned to this stack instance.
sisStackId :: Lens' StackInstanceSummary (Maybe Text) Source #
The ID of the stack instance.
sisStackSetId :: Lens' StackInstanceSummary (Maybe Text) Source #
The name or unique ID of the stack set that the stack instance is associated with.
StackResource
data StackResource Source #
The StackResource data type.
See: stackResource smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ResourceStatus | |
| -> StackResource |
Creates a value of StackResource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srPhysicalResourceId- The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.srResourceStatusReason- Success/failure message associated with the resource.srStackId- Unique identifier of the stack.srDescription- User defined description associated with the resource.srStackName- The name associated with the stack.srLogicalResourceId- The logical name of the resource specified in the template.srResourceType- Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)srTimestamp- Time the status was updated.srResourceStatus- Current status of the resource.
srPhysicalResourceId :: Lens' StackResource (Maybe Text) Source #
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
srResourceStatusReason :: Lens' StackResource (Maybe Text) Source #
Success/failure message associated with the resource.
srDescription :: Lens' StackResource (Maybe Text) Source #
User defined description associated with the resource.
srStackName :: Lens' StackResource (Maybe Text) Source #
The name associated with the stack.
srLogicalResourceId :: Lens' StackResource Text Source #
The logical name of the resource specified in the template.
srResourceType :: Lens' StackResource Text Source #
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
srTimestamp :: Lens' StackResource UTCTime Source #
Time the status was updated.
srResourceStatus :: Lens' StackResource ResourceStatus Source #
Current status of the resource.
StackResourceDetail
data StackResourceDetail Source #
Contains detailed information about the specified stack resource.
See: stackResourceDetail smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ResourceStatus | |
| -> StackResourceDetail |
Creates a value of StackResourceDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srdPhysicalResourceId- The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.srdResourceStatusReason- Success/failure message associated with the resource.srdMetadata- The content of theMetadataattribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.srdStackId- Unique identifier of the stack.srdDescription- User defined description associated with the resource.srdStackName- The name associated with the stack.srdLogicalResourceId- The logical name of the resource specified in the template.srdResourceType- Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)srdLastUpdatedTimestamp- Time the status was updated.srdResourceStatus- Current status of the resource.
srdPhysicalResourceId :: Lens' StackResourceDetail (Maybe Text) Source #
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
srdResourceStatusReason :: Lens' StackResourceDetail (Maybe Text) Source #
Success/failure message associated with the resource.
srdMetadata :: Lens' StackResourceDetail (Maybe Text) Source #
The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
srdStackId :: Lens' StackResourceDetail (Maybe Text) Source #
Unique identifier of the stack.
srdDescription :: Lens' StackResourceDetail (Maybe Text) Source #
User defined description associated with the resource.
srdStackName :: Lens' StackResourceDetail (Maybe Text) Source #
The name associated with the stack.
srdLogicalResourceId :: Lens' StackResourceDetail Text Source #
The logical name of the resource specified in the template.
srdResourceType :: Lens' StackResourceDetail Text Source #
Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
srdLastUpdatedTimestamp :: Lens' StackResourceDetail UTCTime Source #
Time the status was updated.
srdResourceStatus :: Lens' StackResourceDetail ResourceStatus Source #
Current status of the resource.
StackResourceSummary
data StackResourceSummary Source #
Contains high-level information about the specified stack resource.
See: stackResourceSummary smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> ResourceStatus | |
| -> StackResourceSummary |
Creates a value of StackResourceSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srsPhysicalResourceId- The name or unique identifier that corresponds to a physical instance ID of the resource.srsResourceStatusReason- Success/failure message associated with the resource.srsLogicalResourceId- The logical name of the resource specified in the template.srsResourceType- Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)srsLastUpdatedTimestamp- Time the status was updated.srsResourceStatus- Current status of the resource.
srsPhysicalResourceId :: Lens' StackResourceSummary (Maybe Text) Source #
The name or unique identifier that corresponds to a physical instance ID of the resource.
srsResourceStatusReason :: Lens' StackResourceSummary (Maybe Text) Source #
Success/failure message associated with the resource.
srsLogicalResourceId :: Lens' StackResourceSummary Text Source #
The logical name of the resource specified in the template.
srsResourceType :: Lens' StackResourceSummary Text Source #
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
srsLastUpdatedTimestamp :: Lens' StackResourceSummary UTCTime Source #
Time the status was updated.
srsResourceStatus :: Lens' StackResourceSummary ResourceStatus Source #
Current status of the resource.
StackSet
A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.
See: stackSet smart constructor.
Creates a value of StackSet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssStatus- The status of the stack set.ssAdministrationRoleARN- The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide .ssStackSetARN- The Amazon Resource Number (ARN) of the stack set.ssParameters- A list of input parameters for a stack set.ssTemplateBody- The structure that contains the body of the template that was used to create or update the stack set.ssStackSetName- The name that's associated with the stack set.ssDescription- A description of the stack set that you specify when the stack set is created or updated.ssCapabilities- The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.ssTags- A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.ssStackSetId- The ID of the stack set.
ssAdministrationRoleARN :: Lens' StackSet (Maybe Text) Source #
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide .
ssStackSetARN :: Lens' StackSet (Maybe Text) Source #
The Amazon Resource Number (ARN) of the stack set.
ssTemplateBody :: Lens' StackSet (Maybe Text) Source #
The structure that contains the body of the template that was used to create or update the stack set.
ssStackSetName :: Lens' StackSet (Maybe Text) Source #
The name that's associated with the stack set.
ssDescription :: Lens' StackSet (Maybe Text) Source #
A description of the stack set that you specify when the stack set is created or updated.
ssCapabilities :: Lens' StackSet [Capability] Source #
The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
ssTags :: Lens' StackSet [Tag] Source #
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
StackSetOperation
data StackSetOperation Source #
The structure that contains information about a stack set operation.
See: stackSetOperation smart constructor.
Instances
stackSetOperation :: StackSetOperation Source #
Creates a value of StackSetOperation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssoStatus- The 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 toFAILED. This in turn sets the status of the operation as a whole toFAILED, and AWS CloudFormation cancels the operation in any remaining regions. *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.ssoAdministrationRoleARN- The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide .ssoAction- The type of stack set operation:CREATE,UPDATE, orDELETE. Create and delete operations affect only the specified stack set 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.ssoEndTimestamp- 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.ssoCreationTimestamp- 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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.ssoOperationPreferences- The preferences for how AWS CloudFormation performs this stack set operation.ssoOperationId- The unique ID of a stack set operation.ssoRetainStacks- For stack set operations of action typeDELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.ssoStackSetId- The ID of the stack set.
ssoStatus :: Lens' StackSetOperation (Maybe StackSetOperationStatus) Source #
The 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 AWS CloudFormation cancels the operation in any remaining regions. * 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.
ssoAdministrationRoleARN :: Lens' StackSetOperation (Maybe Text) Source #
The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide .
ssoAction :: Lens' StackSetOperation (Maybe StackSetOperationAction) Source #
The type of stack set operation: CREATE , UPDATE , or DELETE . Create and delete operations affect only the specified stack set 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.
ssoEndTimestamp :: Lens' StackSetOperation (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.
ssoCreationTimestamp :: Lens' StackSetOperation (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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
ssoOperationPreferences :: Lens' StackSetOperation (Maybe StackSetOperationPreferences) Source #
The preferences for how AWS CloudFormation performs this stack set operation.
ssoOperationId :: Lens' StackSetOperation (Maybe Text) Source #
The unique ID of a stack set operation.
ssoRetainStacks :: Lens' StackSetOperation (Maybe Bool) Source #
For stack set operations of action type DELETE , specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.
ssoStackSetId :: Lens' StackSetOperation (Maybe Text) Source #
The ID of the stack set.
StackSetOperationPreferences
data StackSetOperationPreferences Source #
The user-specified preferences for how AWS CloudFormation performs a stack set operation.
For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options .
See: stackSetOperationPreferences smart constructor.
Instances
stackSetOperationPreferences :: StackSetOperationPreferences Source #
Creates a value of StackSetOperationPreferences with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssopRegionOrder- The order of the regions in where you want to perform the stack operation.ssopMaxConcurrentCount- The maximum number of accounts in which to perform this operation at one time. This is dependent on the value ofFailureToleranceCount—MaxConcurrentCountis at most one more than theFailureToleranceCount. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify eitherMaxConcurrentCountorMaxConcurrentPercentage, but not both.ssopMaxConcurrentPercentage- The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify eitherMaxConcurrentCountorMaxConcurrentPercentage, but not both.ssopFailureToleranceCount- The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. Conditional: You must specify eitherFailureToleranceCountorFailureTolerancePercentage(but not both).ssopFailureTolerancePercentage- The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. Conditional: You must specify eitherFailureToleranceCountorFailureTolerancePercentage, but not both.
ssopRegionOrder :: Lens' StackSetOperationPreferences [Text] Source #
The order of the regions in where you want to perform the stack operation.
ssopMaxConcurrentCount :: Lens' StackSetOperationPreferences (Maybe Natural) Source #
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount —MaxConcurrentCount is at most one more than the FailureToleranceCount . Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage , but not both.
ssopMaxConcurrentPercentage :: Lens' StackSetOperationPreferences (Maybe Natural) Source #
The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage , but not both.
ssopFailureToleranceCount :: Lens' StackSetOperationPreferences (Maybe Natural) Source #
The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
ssopFailureTolerancePercentage :: Lens' StackSetOperationPreferences (Maybe Natural) Source #
The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.
StackSetOperationResultSummary
data StackSetOperationResultSummary Source #
The structure that contains information about a specified operation's results for a given account in a given region.
See: stackSetOperationResultSummary smart constructor.
Instances
stackSetOperationResultSummary :: StackSetOperationResultSummary Source #
Creates a value of StackSetOperationResultSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssorsStatus- 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 cancelled. 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.ssorsAccount- The name of the AWS account for this operation result.ssorsAccountGateResult- The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an accountssorsRegion- The name of the AWS region for this operation result.ssorsStatusReason- The reason for the assigned result status.
ssorsStatus :: 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 cancelled. 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.
ssorsAccount :: Lens' StackSetOperationResultSummary (Maybe Text) Source #
The name of the AWS account for this operation result.
ssorsAccountGateResult :: Lens' StackSetOperationResultSummary (Maybe AccountGateResult) Source #
The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account
ssorsRegion :: Lens' StackSetOperationResultSummary (Maybe Text) Source #
The name of the AWS region for this operation result.
ssorsStatusReason :: Lens' StackSetOperationResultSummary (Maybe Text) Source #
The reason for the assigned result status.
StackSetOperationSummary
data StackSetOperationSummary Source #
The structures that contain summary information about the specified operation.
See: stackSetOperationSummary smart constructor.
Instances
stackSetOperationSummary :: StackSetOperationSummary Source #
Creates a value of StackSetOperationSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssosStatus- 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 toFAILED. This in turn sets the status of the operation as a whole toFAILED, and AWS CloudFormation cancels the operation in any remaining regions. *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.ssosAction- The type of operation:CREATE,UPDATE, orDELETE. 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.ssosEndTimestamp- 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.ssosCreationTimestamp- 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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.ssosOperationId- The unique ID of the stack set operation.
ssosStatus :: 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 AWS CloudFormation cancels the operation in any remaining regions. * 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.
ssosAction :: 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.
ssosEndTimestamp :: 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.
ssosCreationTimestamp :: 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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
ssosOperationId :: Lens' StackSetOperationSummary (Maybe Text) Source #
The unique ID of the stack set operation.
StackSetSummary
data StackSetSummary Source #
The structures that contain summary information about the specified stack set.
See: stackSetSummary smart constructor.
stackSetSummary :: StackSetSummary Source #
Creates a value of StackSetSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sssStatus- The status of the stack set.sssStackSetName- The name of the stack set.sssDescription- A description of the stack set that you specify when the stack set is created or updated.sssStackSetId- The ID of the stack set.
sssStatus :: Lens' StackSetSummary (Maybe StackSetStatus) Source #
The status of the stack set.
sssStackSetName :: Lens' StackSetSummary (Maybe Text) Source #
The name of the stack set.
sssDescription :: Lens' StackSetSummary (Maybe Text) Source #
A description of the stack set that you specify when the stack set is created or updated.
sssStackSetId :: Lens' StackSetSummary (Maybe Text) Source #
The ID of the stack set.
StackSummary
data StackSummary Source #
The StackSummary Data Type
See: stackSummary smart constructor.
Arguments
| :: Text | |
| -> UTCTime | |
| -> StackStatus | |
| -> StackSummary |
Creates a value of StackSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssLastUpdatedTime- The time the stack was last updated. This field will only be returned if the stack has been updated at least once.ssRootId- For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .ssStackStatusReason- Success/Failure message associated with the stack status.ssTemplateDescription- The template description of the template used to create the stack.ssDeletionTime- The time the stack was deleted.ssStackId- Unique stack identifier.ssParentId- For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .ssStackName- The name associated with the stack.ssCreationTime- The time the stack was created.ssStackStatus- The current status of the stack.
ssLastUpdatedTime :: Lens' StackSummary (Maybe UTCTime) Source #
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
ssRootId :: Lens' StackSummary (Maybe Text) Source #
For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .
ssStackStatusReason :: Lens' StackSummary (Maybe Text) Source #
Success/Failure message associated with the stack status.
ssTemplateDescription :: Lens' StackSummary (Maybe Text) Source #
The template description of the template used to create the stack.
ssDeletionTime :: Lens' StackSummary (Maybe UTCTime) Source #
The time the stack was deleted.
ssParentId :: Lens' StackSummary (Maybe Text) Source #
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide .
ssStackName :: Lens' StackSummary Text Source #
The name associated with the stack.
ssCreationTime :: Lens' StackSummary UTCTime Source #
The time the stack was created.
ssStackStatus :: Lens' StackSummary StackStatus Source #
The current status of the stack.
Tag
The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.
See: tag smart constructor.
Creates a value of Tag with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tagKey- Required . A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix:aws:.tagValue- Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
tagKey :: Lens' Tag Text Source #
Required . A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws: .
tagValue :: Lens' Tag Text Source #
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
TemplateParameter
data TemplateParameter Source #
The TemplateParameter data type.
See: templateParameter smart constructor.
Instances
templateParameter :: TemplateParameter Source #
Creates a value of TemplateParameter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpParameterKey- The name associated with the parameter.tpDefaultValue- The default value associated with the parameter.tpNoEcho- Flag indicating whether the parameter should be displayed as plain text in logs and UIs.tpDescription- User defined description associated with the parameter.
tpParameterKey :: Lens' TemplateParameter (Maybe Text) Source #
The name associated with the parameter.
tpDefaultValue :: Lens' TemplateParameter (Maybe Text) Source #
The default value associated with the parameter.
tpNoEcho :: Lens' TemplateParameter (Maybe Bool) Source #
Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
tpDescription :: Lens' TemplateParameter (Maybe Text) Source #
User defined description associated with the parameter.