amazonka-cloudformation-1.6.1: Amazon CloudFormation SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudFormation.DescribeChangeSet

Contents

Description

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

Creating a Request

describeChangeSet Source #

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 the DescribeChangeSet 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
Eq DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Data DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeChangeSet -> c DescribeChangeSet #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeChangeSet #

toConstr :: DescribeChangeSet -> Constr #

dataTypeOf :: DescribeChangeSet -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeChangeSet) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeChangeSet) #

gmapT :: (forall b. Data b => b -> b) -> DescribeChangeSet -> DescribeChangeSet #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChangeSet -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChangeSet -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeChangeSet -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeChangeSet -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeChangeSet -> m DescribeChangeSet #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChangeSet -> m DescribeChangeSet #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChangeSet -> m DescribeChangeSet #

Read DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Show DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Generic DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Associated Types

type Rep DescribeChangeSet :: Type -> Type #

Hashable DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

AWSRequest DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Associated Types

type Rs DescribeChangeSet :: Type #

ToHeaders DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

ToPath DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

ToQuery DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

NFData DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Methods

rnf :: DescribeChangeSet -> () #

type Rep DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

type Rep DescribeChangeSet = D1 (MetaData "DescribeChangeSet" "Network.AWS.CloudFormation.DescribeChangeSet" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "DescribeChangeSet'" PrefixI True) (S1 (MetaSel (Just "_desNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desChangeSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DescribeChangeSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

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 of Change 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 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 - 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 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 - 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 as CREATE_IN_PROGRESS , CREATE_COMPLETE , or FAILED .

data DescribeChangeSetResponse Source #

The output for the DescribeChangeSet action.

See: describeChangeSetResponse smart constructor.

Instances
Eq DescribeChangeSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Data DescribeChangeSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeChangeSetResponse -> c DescribeChangeSetResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeChangeSetResponse #

toConstr :: DescribeChangeSetResponse -> Constr #

dataTypeOf :: DescribeChangeSetResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeChangeSetResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeChangeSetResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeChangeSetResponse -> DescribeChangeSetResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChangeSetResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeChangeSetResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeChangeSetResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeChangeSetResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeChangeSetResponse -> m DescribeChangeSetResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChangeSetResponse -> m DescribeChangeSetResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeChangeSetResponse -> m DescribeChangeSetResponse #

Read DescribeChangeSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Show DescribeChangeSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Generic DescribeChangeSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

Associated Types

type Rep DescribeChangeSetResponse :: Type -> Type #

NFData DescribeChangeSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

type Rep DescribeChangeSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeChangeSet

type Rep DescribeChangeSetResponse = D1 (MetaData "DescribeChangeSetResponse" "Network.AWS.CloudFormation.DescribeChangeSet" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "DescribeChangeSetResponse'" PrefixI True) ((((S1 (MetaSel (Just "_desrsCreationTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 (MetaSel (Just "_desrsChanges") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Change]))) :*: (S1 (MetaSel (Just "_desrsNotificationARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_desrsChangeSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_desrsExecutionStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ExecutionStatus)) :*: S1 (MetaSel (Just "_desrsChangeSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_desrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter]))))) :*: (((S1 (MetaSel (Just "_desrsStatusReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_desrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_desrsCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Capability])))) :*: ((S1 (MetaSel (Just "_desrsRollbackConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RollbackConfiguration)) :*: S1 (MetaSel (Just "_desrsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 (MetaSel (Just "_desrsStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_desrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_desrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ChangeSetStatus)))))))

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.

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.

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.

desrsStatus :: Lens' DescribeChangeSetResponse ChangeSetStatus Source #

The current status of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or FAILED .