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

Contents

Description

Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.

Synopsis

Creating a Request

validateTemplate :: ValidateTemplate #

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

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

  • vtTemplateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody . If both are passed, only TemplateBody is used.
  • vtTemplateURL - 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, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody . If both are passed, only TemplateBody is used.

data ValidateTemplate #

The input for ValidateTemplate action.

See: validateTemplate smart constructor.

Instances

Eq ValidateTemplate # 
Data ValidateTemplate # 

Methods

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

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

toConstr :: ValidateTemplate -> Constr #

dataTypeOf :: ValidateTemplate -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ValidateTemplate # 
Show ValidateTemplate # 
Generic ValidateTemplate # 
Hashable ValidateTemplate # 
NFData ValidateTemplate # 

Methods

rnf :: ValidateTemplate -> () #

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

Request Lenses

vtTemplateBody :: Lens' ValidateTemplate (Maybe Text) #

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody . If both are passed, only TemplateBody is used.

vtTemplateURL :: Lens' ValidateTemplate (Maybe Text) #

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, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody . If both are passed, only TemplateBody is used.

Destructuring the Response

validateTemplateResponse #

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

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

data ValidateTemplateResponse #

The output for ValidateTemplate action.

See: validateTemplateResponse smart constructor.

Instances

Eq ValidateTemplateResponse # 
Data ValidateTemplateResponse # 

Methods

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

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

toConstr :: ValidateTemplateResponse -> Constr #

dataTypeOf :: ValidateTemplateResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ValidateTemplateResponse # 
Show ValidateTemplateResponse # 
Generic ValidateTemplateResponse # 
NFData ValidateTemplateResponse # 
type Rep ValidateTemplateResponse # 
type Rep ValidateTemplateResponse = D1 (MetaData "ValidateTemplateResponse" "Network.AWS.CloudFormation.ValidateTemplate" "amazonka-cloudformation-1.4.5-GkPqDOYcHIlLStUFA5eeUs" False) (C1 (MetaCons "ValidateTemplateResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vtrsDeclaredTransforms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_vtrsCapabilitiesReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_vtrsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [TemplateParameter]))))) ((:*:) (S1 (MetaSel (Just Symbol "_vtrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_vtrsCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Capability]))) (S1 (MetaSel (Just Symbol "_vtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))))

Response Lenses

vtrsDeclaredTransforms :: Lens' ValidateTemplateResponse [Text] #

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

vtrsCapabilitiesReason :: Lens' ValidateTemplateResponse (Maybe Text) #

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

vtrsParameters :: Lens' ValidateTemplateResponse [TemplateParameter] #

A list of TemplateParameter structures.

vtrsDescription :: Lens' ValidateTemplateResponse (Maybe Text) #

The description found within the template.

vtrsCapabilities :: Lens' ValidateTemplateResponse [Capability] #

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 .

vtrsResponseStatus :: Lens' ValidateTemplateResponse Int #

  • - | The response status code.