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.GetTemplateSummary

Contents

Description

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

Synopsis

Creating a Request

getTemplateSummary :: GetTemplateSummary Source #

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

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

  • gtsTemplateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .
  • gtsTemplateURL - Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .
  • gtsStackName - The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .

data GetTemplateSummary Source #

The input for the GetTemplateSummary action.

See: getTemplateSummary smart constructor.

Instances

Eq GetTemplateSummary Source # 
Data GetTemplateSummary Source # 

Methods

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

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

toConstr :: GetTemplateSummary -> Constr #

dataTypeOf :: GetTemplateSummary -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetTemplateSummary Source # 
Show GetTemplateSummary Source # 
Generic GetTemplateSummary Source # 
Hashable GetTemplateSummary Source # 
NFData GetTemplateSummary Source # 

Methods

rnf :: GetTemplateSummary -> () #

AWSRequest GetTemplateSummary Source # 
ToPath GetTemplateSummary Source # 
ToHeaders GetTemplateSummary Source # 
ToQuery GetTemplateSummary Source # 
type Rep GetTemplateSummary Source # 
type Rep GetTemplateSummary = D1 (MetaData "GetTemplateSummary" "Network.AWS.CloudFormation.GetTemplateSummary" "amazonka-cloudformation-1.4.5-G0stfcEaDzC4JoYZoVvUrE" False) (C1 (MetaCons "GetTemplateSummary'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gtsTemplateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gtsTemplateURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gtsStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Rs GetTemplateSummary Source # 

Request Lenses

gtsTemplateBody :: Lens' GetTemplateSummary (Maybe Text) Source #

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .

gtsTemplateURL :: Lens' GetTemplateSummary (Maybe Text) Source #

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .

gtsStackName :: Lens' GetTemplateSummary (Maybe Text) Source #

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName , TemplateBody , or TemplateURL .

Destructuring the Response

getTemplateSummaryResponse Source #

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

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

  • gtsrsDeclaredTransforms - A list of the transforms that are declared in the template.
  • gtsrsVersion - The AWS template format version, which identifies the capabilities of the template.
  • gtsrsCapabilitiesReason - The list of resources that generated the values in the Capabilities response element.
  • gtsrsParameters - A list of parameter declarations that describe various properties for each parameter.
  • gtsrsMetadata - The value that is defined for the Metadata property of the template.
  • gtsrsDescription - The value that is defined in the Description property of the template.
  • gtsrsCapabilities - The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .
  • gtsrsResourceTypes - A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance , AWS::Dynamo::Table , and Custom::MyCustomInstance .
  • gtsrsResponseStatus - -- | The response status code.

data GetTemplateSummaryResponse Source #

The output for the GetTemplateSummary action.

See: getTemplateSummaryResponse smart constructor.

Instances

Eq GetTemplateSummaryResponse Source # 
Data GetTemplateSummaryResponse Source # 

Methods

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

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

toConstr :: GetTemplateSummaryResponse -> Constr #

dataTypeOf :: GetTemplateSummaryResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetTemplateSummaryResponse Source # 
Show GetTemplateSummaryResponse Source # 
Generic GetTemplateSummaryResponse Source # 
NFData GetTemplateSummaryResponse Source # 
type Rep GetTemplateSummaryResponse Source # 
type Rep GetTemplateSummaryResponse = D1 (MetaData "GetTemplateSummaryResponse" "Network.AWS.CloudFormation.GetTemplateSummary" "amazonka-cloudformation-1.4.5-G0stfcEaDzC4JoYZoVvUrE" False) (C1 (MetaCons "GetTemplateSummaryResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gtsrsDeclaredTransforms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_gtsrsVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gtsrsCapabilitiesReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gtsrsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ParameterDeclaration]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gtsrsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gtsrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gtsrsCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Capability]))) ((:*:) (S1 (MetaSel (Just Symbol "_gtsrsResourceTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_gtsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))))

Response Lenses

gtsrsDeclaredTransforms :: Lens' GetTemplateSummaryResponse [Text] Source #

A list of the transforms that are declared in the template.

gtsrsVersion :: Lens' GetTemplateSummaryResponse (Maybe Text) Source #

The AWS template format version, which identifies the capabilities of the template.

gtsrsCapabilitiesReason :: Lens' GetTemplateSummaryResponse (Maybe Text) Source #

The list of resources that generated the values in the Capabilities response element.

gtsrsParameters :: Lens' GetTemplateSummaryResponse [ParameterDeclaration] Source #

A list of parameter declarations that describe various properties for each parameter.

gtsrsMetadata :: Lens' GetTemplateSummaryResponse (Maybe Text) Source #

The value that is defined for the Metadata property of the template.

gtsrsDescription :: Lens' GetTemplateSummaryResponse (Maybe Text) Source #

The value that is defined in the Description property of the template.

gtsrsCapabilities :: Lens' GetTemplateSummaryResponse [Capability] Source #

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

gtsrsResourceTypes :: Lens' GetTemplateSummaryResponse [Text] Source #

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance , AWS::Dynamo::Table , and Custom::MyCustomInstance .