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 |
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
Synopsis
- describeChangeSet :: Text -> DescribeChangeSet
- data DescribeChangeSet
- desNextToken :: Lens' DescribeChangeSet (Maybe Text)
- desStackName :: Lens' DescribeChangeSet (Maybe Text)
- desChangeSetName :: Lens' DescribeChangeSet Text
- describeChangeSetResponse :: Int -> ChangeSetStatus -> DescribeChangeSetResponse
- data DescribeChangeSetResponse
- desrsCreationTime :: Lens' DescribeChangeSetResponse (Maybe UTCTime)
- desrsChanges :: Lens' DescribeChangeSetResponse [Change]
- desrsNotificationARNs :: Lens' DescribeChangeSetResponse [Text]
- desrsChangeSetName :: Lens' DescribeChangeSetResponse (Maybe Text)
- desrsExecutionStatus :: Lens' DescribeChangeSetResponse (Maybe ExecutionStatus)
- desrsChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text)
- desrsNextToken :: Lens' DescribeChangeSetResponse (Maybe Text)
- desrsParameters :: Lens' DescribeChangeSetResponse [Parameter]
- desrsStatusReason :: Lens' DescribeChangeSetResponse (Maybe Text)
- desrsStackId :: Lens' DescribeChangeSetResponse (Maybe Text)
- desrsDescription :: Lens' DescribeChangeSetResponse (Maybe Text)
- desrsCapabilities :: Lens' DescribeChangeSetResponse [Capability]
- desrsRollbackConfiguration :: Lens' DescribeChangeSetResponse (Maybe RollbackConfiguration)
- desrsTags :: Lens' DescribeChangeSetResponse [Tag]
- desrsStackName :: Lens' DescribeChangeSetResponse (Maybe Text)
- desrsResponseStatus :: Lens' DescribeChangeSetResponse Int
- desrsStatus :: Lens' DescribeChangeSetResponse ChangeSetStatus
Creating a Request
Creates a value of DescribeChangeSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
desNextToken
- A string (provided by theDescribeChangeSet
response output) that identifies the next page of information that you want to retrieve.desStackName
- If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.desChangeSetName
- The name or Amazon Resource Name (ARN) of the change set that you want to describe.
data DescribeChangeSet Source #
The input for the DescribeChangeSet
action.
See: describeChangeSet
smart constructor.
Instances
Request Lenses
desNextToken :: Lens' DescribeChangeSet (Maybe Text) Source #
A string (provided by the DescribeChangeSet
response output) that identifies the next page of information that you want to retrieve.
desStackName :: Lens' DescribeChangeSet (Maybe Text) Source #
If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
desChangeSetName :: Lens' DescribeChangeSet Text Source #
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
Destructuring the Response
describeChangeSetResponse Source #
Creates a value of DescribeChangeSetResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
desrsCreationTime
- The start time when the change set was created, in UTC.desrsChanges
- A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.desrsNotificationARNs
- The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.desrsChangeSetName
- The name of the change set.desrsExecutionStatus
- 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 anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.desrsChangeSetId
- The ARN of the change set.desrsNextToken
- If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.desrsParameters
- A list ofParameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.desrsStatusReason
- A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.desrsStackId
- The ARN of the stack that is associated with the change set.desrsDescription
- Information about the change set.desrsCapabilities
- If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.desrsRollbackConfiguration
- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.desrsTags
- If you execute the change set, the tags that will be associated with the stack.desrsStackName
- The name of the stack that is associated with the change set.desrsResponseStatus
- -- | The response status code.desrsStatus
- The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.
data DescribeChangeSetResponse Source #
The output for the DescribeChangeSet
action.
See: describeChangeSetResponse
smart constructor.
Instances
Response Lenses
desrsCreationTime :: Lens' DescribeChangeSetResponse (Maybe UTCTime) Source #
The start time when the change set was created, in UTC.
desrsChanges :: Lens' DescribeChangeSetResponse [Change] Source #
A list of Change
structures that describes the resources AWS CloudFormation changes if you execute the change set.
desrsNotificationARNs :: Lens' DescribeChangeSetResponse [Text] Source #
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
desrsChangeSetName :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The name of the change set.
desrsExecutionStatus :: Lens' DescribeChangeSetResponse (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.
desrsChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The ARN of the change set.
desrsNextToken :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
desrsParameters :: Lens' DescribeChangeSetResponse [Parameter] Source #
A list of Parameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
desrsStatusReason :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
desrsStackId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The ARN of the stack that is associated with the change set.
desrsDescription :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
Information about the change set.
desrsCapabilities :: Lens' DescribeChangeSetResponse [Capability] Source #
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
desrsRollbackConfiguration :: Lens' DescribeChangeSetResponse (Maybe RollbackConfiguration) Source #
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
desrsTags :: Lens' DescribeChangeSetResponse [Tag] Source #
If you execute the change set, the tags that will be associated with the stack.
desrsStackName :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The name of the stack that is associated with the change set.
desrsResponseStatus :: Lens' DescribeChangeSetResponse Int Source #
- - | The response status code.
desrsStatus :: Lens' DescribeChangeSetResponse ChangeSetStatus Source #
The current status of the change set, such as CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or FAILED
.