Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
This operation returns paginated results.
Synopsis
- data DescribeChangeSet = DescribeChangeSet' {}
- newDescribeChangeSet :: Text -> DescribeChangeSet
- describeChangeSet_nextToken :: Lens' DescribeChangeSet (Maybe Text)
- describeChangeSet_stackName :: Lens' DescribeChangeSet (Maybe Text)
- describeChangeSet_changeSetName :: Lens' DescribeChangeSet Text
- data DescribeChangeSetResponse = DescribeChangeSetResponse' {
- capabilities :: Maybe [Capability]
- changeSetId :: Maybe Text
- changeSetName :: Maybe Text
- changes :: Maybe [Change]
- creationTime :: Maybe ISO8601
- description :: Maybe Text
- executionStatus :: Maybe ExecutionStatus
- includeNestedStacks :: Maybe Bool
- nextToken :: Maybe Text
- notificationARNs :: Maybe [Text]
- parameters :: Maybe [Parameter]
- parentChangeSetId :: Maybe Text
- rollbackConfiguration :: Maybe RollbackConfiguration
- rootChangeSetId :: Maybe Text
- stackId :: Maybe Text
- stackName :: Maybe Text
- statusReason :: Maybe Text
- tags :: Maybe [Tag]
- httpStatus :: Int
- status :: ChangeSetStatus
- newDescribeChangeSetResponse :: Int -> ChangeSetStatus -> DescribeChangeSetResponse
- describeChangeSetResponse_capabilities :: Lens' DescribeChangeSetResponse (Maybe [Capability])
- describeChangeSetResponse_changeSetId :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_changeSetName :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_changes :: Lens' DescribeChangeSetResponse (Maybe [Change])
- describeChangeSetResponse_creationTime :: Lens' DescribeChangeSetResponse (Maybe UTCTime)
- describeChangeSetResponse_description :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_executionStatus :: Lens' DescribeChangeSetResponse (Maybe ExecutionStatus)
- describeChangeSetResponse_includeNestedStacks :: Lens' DescribeChangeSetResponse (Maybe Bool)
- describeChangeSetResponse_nextToken :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_notificationARNs :: Lens' DescribeChangeSetResponse (Maybe [Text])
- describeChangeSetResponse_parameters :: Lens' DescribeChangeSetResponse (Maybe [Parameter])
- describeChangeSetResponse_parentChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_rollbackConfiguration :: Lens' DescribeChangeSetResponse (Maybe RollbackConfiguration)
- describeChangeSetResponse_rootChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_stackId :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_stackName :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_statusReason :: Lens' DescribeChangeSetResponse (Maybe Text)
- describeChangeSetResponse_tags :: Lens' DescribeChangeSetResponse (Maybe [Tag])
- describeChangeSetResponse_httpStatus :: Lens' DescribeChangeSetResponse Int
- describeChangeSetResponse_status :: Lens' DescribeChangeSetResponse ChangeSetStatus
Creating a Request
data DescribeChangeSet Source #
The input for the DescribeChangeSet action.
See: newDescribeChangeSet
smart constructor.
DescribeChangeSet' | |
|
Instances
Create a value of DescribeChangeSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChangeSet
, describeChangeSet_nextToken
- A string (provided by the DescribeChangeSet response output) that
identifies the next page of information that you want to retrieve.
DescribeChangeSet
, describeChangeSet_stackName
- If you specified the name of a change set, specify the stack name or ID
(ARN) of the change set you want to describe.
DescribeChangeSet
, describeChangeSet_changeSetName
- The name or Amazon Resource Name (ARN) of the change set that you want
to describe.
Request Lenses
describeChangeSet_nextToken :: 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.
describeChangeSet_stackName :: 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.
describeChangeSet_changeSetName :: Lens' DescribeChangeSet Text Source #
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
Destructuring the Response
data DescribeChangeSetResponse Source #
The output for the DescribeChangeSet action.
See: newDescribeChangeSetResponse
smart constructor.
DescribeChangeSetResponse' | |
|
Instances
newDescribeChangeSetResponse Source #
Create a value of DescribeChangeSetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChangeSetResponse
, describeChangeSetResponse_capabilities
- If you execute the change set, the list of capabilities that were
explicitly acknowledged when the change set was created.
DescribeChangeSetResponse
, describeChangeSetResponse_changeSetId
- The Amazon Resource Name (ARN) of the change set.
DescribeChangeSet
, describeChangeSetResponse_changeSetName
- The name of the change set.
$sel:changes:DescribeChangeSetResponse'
, describeChangeSetResponse_changes
- A list of Change
structures that describes the resources
CloudFormation changes if you execute the change set.
DescribeChangeSetResponse
, describeChangeSetResponse_creationTime
- The start time when the change set was created, in UTC.
DescribeChangeSetResponse
, describeChangeSetResponse_description
- Information about the change set.
DescribeChangeSetResponse
, describeChangeSetResponse_executionStatus
- 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 CloudFormation is still creating it or in an OBSOLETE
state
because the stack was already updated.
DescribeChangeSetResponse
, describeChangeSetResponse_includeNestedStacks
- Verifies if IncludeNestedStacks
is set to True
.
DescribeChangeSet
, describeChangeSetResponse_nextToken
- 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.
DescribeChangeSetResponse
, describeChangeSetResponse_notificationARNs
- The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics
that will be associated with the stack if you execute the change set.
DescribeChangeSetResponse
, describeChangeSetResponse_parameters
- 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.
DescribeChangeSetResponse
, describeChangeSetResponse_parentChangeSetId
- Specifies the change set ID of the parent change set in the current
nested change set hierarchy.
DescribeChangeSetResponse
, describeChangeSetResponse_rollbackConfiguration
- The rollback triggers for CloudFormation to monitor during stack
creation and updating operations, and for the specified monitoring
period afterwards.
DescribeChangeSetResponse
, describeChangeSetResponse_rootChangeSetId
- Specifies the change set ID of the root change set in the current nested
change set hierarchy.
DescribeChangeSetResponse
, describeChangeSetResponse_stackId
- The Amazon Resource Name (ARN) of the stack that's associated with the
change set.
DescribeChangeSet
, describeChangeSetResponse_stackName
- The name of the stack that's associated with the change set.
DescribeChangeSetResponse
, describeChangeSetResponse_statusReason
- A description of the change set's status. For example, if your attempt
to create a change set failed, CloudFormation shows the error message.
DescribeChangeSetResponse
, describeChangeSetResponse_tags
- If you execute the change set, the tags that will be associated with the
stack.
$sel:httpStatus:DescribeChangeSetResponse'
, describeChangeSetResponse_httpStatus
- The response's http status code.
DescribeChangeSetResponse
, describeChangeSetResponse_status
- The current status of the change set, such as CREATE_IN_PROGRESS
,
CREATE_COMPLETE
, or FAILED
.
Response Lenses
describeChangeSetResponse_capabilities :: Lens' DescribeChangeSetResponse (Maybe [Capability]) Source #
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
describeChangeSetResponse_changeSetId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the change set.
describeChangeSetResponse_changeSetName :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The name of the change set.
describeChangeSetResponse_changes :: Lens' DescribeChangeSetResponse (Maybe [Change]) Source #
A list of Change
structures that describes the resources
CloudFormation changes if you execute the change set.
describeChangeSetResponse_creationTime :: Lens' DescribeChangeSetResponse (Maybe UTCTime) Source #
The start time when the change set was created, in UTC.
describeChangeSetResponse_description :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
Information about the change set.
describeChangeSetResponse_executionStatus :: 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 CloudFormation is still creating it or in an OBSOLETE
state
because the stack was already updated.
describeChangeSetResponse_includeNestedStacks :: Lens' DescribeChangeSetResponse (Maybe Bool) Source #
Verifies if IncludeNestedStacks
is set to True
.
describeChangeSetResponse_nextToken :: 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.
describeChangeSetResponse_notificationARNs :: Lens' DescribeChangeSetResponse (Maybe [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.
describeChangeSetResponse_parameters :: Lens' DescribeChangeSetResponse (Maybe [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.
describeChangeSetResponse_parentChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
describeChangeSetResponse_rollbackConfiguration :: Lens' DescribeChangeSetResponse (Maybe RollbackConfiguration) Source #
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
describeChangeSetResponse_rootChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
Specifies the change set ID of the root change set in the current nested change set hierarchy.
describeChangeSetResponse_stackId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stack that's associated with the change set.
describeChangeSetResponse_stackName :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
The name of the stack that's associated with the change set.
describeChangeSetResponse_statusReason :: Lens' DescribeChangeSetResponse (Maybe Text) Source #
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
describeChangeSetResponse_tags :: Lens' DescribeChangeSetResponse (Maybe [Tag]) Source #
If you execute the change set, the tags that will be associated with the stack.
describeChangeSetResponse_httpStatus :: Lens' DescribeChangeSetResponse Int Source #
The response's http status code.
describeChangeSetResponse_status :: Lens' DescribeChangeSetResponse ChangeSetStatus Source #
The current status of the change set, such as CREATE_IN_PROGRESS
,
CREATE_COMPLETE
, or FAILED
.