amazonka-cloudformation-1.4.5: Amazon CloudFormation SDK.

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

Network.AWS.CloudFormation.GetTemplate

Contents

Description

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

Synopsis

Creating a Request

getTemplate :: GetTemplate #

Creates a value of GetTemplate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gtChangeSetName - The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName .
  • gtTemplateStage - For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original . To get the template after AWS CloudFormation has processed all transforms, specify Processed . If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original .
  • gtStackName - The name or the unique stack ID that is associated with the stack, which are not always interchangeable: * Running stacks: You can specify either the stack's name or its unique stack ID. * Deleted stacks: You must specify the unique stack ID. Default: There is no default value.

data GetTemplate #

The input for a GetTemplate action.

See: getTemplate smart constructor.

Instances

Eq GetTemplate # 
Data GetTemplate # 

Methods

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

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

toConstr :: GetTemplate -> Constr #

dataTypeOf :: GetTemplate -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetTemplate # 
Show GetTemplate # 
Generic GetTemplate # 

Associated Types

type Rep GetTemplate :: * -> * #

Hashable GetTemplate # 
NFData GetTemplate # 

Methods

rnf :: GetTemplate -> () #

AWSRequest GetTemplate # 
ToQuery GetTemplate # 
ToPath GetTemplate # 
ToHeaders GetTemplate # 

Methods

toHeaders :: GetTemplate -> [Header] #

type Rep GetTemplate # 
type Rep GetTemplate = D1 (MetaData "GetTemplate" "Network.AWS.CloudFormation.GetTemplate" "amazonka-cloudformation-1.4.5-GkPqDOYcHIlLStUFA5eeUs" False) (C1 (MetaCons "GetTemplate'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gtChangeSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gtTemplateStage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TemplateStage))) (S1 (MetaSel (Just Symbol "_gtStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Rs GetTemplate # 

Request Lenses

gtChangeSetName :: Lens' GetTemplate (Maybe Text) #

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName .

gtTemplateStage :: Lens' GetTemplate (Maybe TemplateStage) #

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original . To get the template after AWS CloudFormation has processed all transforms, specify Processed . If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original .

gtStackName :: Lens' GetTemplate (Maybe Text) #

The name or the unique stack ID that is associated with the stack, which are not always interchangeable: * Running stacks: You can specify either the stack's name or its unique stack ID. * Deleted stacks: You must specify the unique stack ID. Default: There is no default value.

Destructuring the Response

getTemplateResponse #

Creates a value of GetTemplateResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gtrsStagesAvailable - The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.
  • gtrsTemplateBody - Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) AWS CloudFormation returns the same template that was used when the stack was created.
  • gtrsResponseStatus - -- | The response status code.

data GetTemplateResponse #

The output for GetTemplate action.

See: getTemplateResponse smart constructor.

Instances

Eq GetTemplateResponse # 
Data GetTemplateResponse # 

Methods

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

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

toConstr :: GetTemplateResponse -> Constr #

dataTypeOf :: GetTemplateResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetTemplateResponse # 
Show GetTemplateResponse # 
Generic GetTemplateResponse # 
NFData GetTemplateResponse # 

Methods

rnf :: GetTemplateResponse -> () #

type Rep GetTemplateResponse # 
type Rep GetTemplateResponse = D1 (MetaData "GetTemplateResponse" "Network.AWS.CloudFormation.GetTemplate" "amazonka-cloudformation-1.4.5-GkPqDOYcHIlLStUFA5eeUs" False) (C1 (MetaCons "GetTemplateResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gtrsStagesAvailable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [TemplateStage]))) ((:*:) (S1 (MetaSel (Just Symbol "_gtrsTemplateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gtrsStagesAvailable :: Lens' GetTemplateResponse [TemplateStage] #

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.

gtrsTemplateBody :: Lens' GetTemplateResponse (Maybe Text) #

Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) AWS CloudFormation returns the same template that was used when the stack was created.

gtrsResponseStatus :: Lens' GetTemplateResponse Int #

  • - | The response status code.