Network.AWS.CloudFormation.ValidateTemplate

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.

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

Methods

(==) :: ValidateTemplate -> ValidateTemplate -> Bool

(/=) :: ValidateTemplate -> ValidateTemplate -> Bool

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

Methods

readsPrec :: Int -> ReadS ValidateTemplate

readList :: ReadS [ValidateTemplate]

readPrec :: ReadPrec ValidateTemplate

readListPrec :: ReadPrec [ValidateTemplate]

Show ValidateTemplate

Methods

showsPrec :: Int -> ValidateTemplate -> ShowS

show :: ValidateTemplate -> String

showList :: [ValidateTemplate] -> ShowS

Generic ValidateTemplate

Associated Types

type Rep ValidateTemplate :: * -> *

Methods

from :: ValidateTemplate -> Rep ValidateTemplate x

to :: Rep ValidateTemplate x -> ValidateTemplate

Hashable ValidateTemplate

Methods

hashWithSalt :: Int -> ValidateTemplate -> Int

hash :: ValidateTemplate -> Int

NFData ValidateTemplate

Methods

rnf :: ValidateTemplate -> ()

AWSRequest ValidateTemplate

Associated Types

type Rs ValidateTemplate :: *

Methods

request :: ValidateTemplate -> Request ValidateTemplate

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ValidateTemplate -> ClientResponse -> m (Response ValidateTemplate)

ToHeaders ValidateTemplate

Methods

toHeaders :: ValidateTemplate -> [Header]

ToPath ValidateTemplate

Methods

toPath :: ValidateTemplate -> ByteString

ToQuery ValidateTemplate

Methods

toQuery :: ValidateTemplate -> QueryString

type Rep ValidateTemplate

type Rep ValidateTemplate = D1 * (MetaData "ValidateTemplate" "Network.AWS.CloudFormation.ValidateTemplate" "amazonka-cloudformation-1.6.0-E2GV66prdF5G8DMBRBifWM" 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

type Rs ValidateTemplate = ValidateTemplateResponse

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

Arguments

:: Int

vtrsResponseStatus

-> 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:

• vtrsDeclaredTransforms - A list of the transforms that are declared in the template.
• vtrsCapabilitiesReason - The list of resources that generated the values in the Capabilities response element.
• vtrsParameters - A list of TemplateParameter structures.
• vtrsDescription - The description found within the template.
• vtrsCapabilities - 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 - -- | The response status code.

data ValidateTemplateResponse

The output for ValidateTemplate action.

See: validateTemplateResponse smart constructor.

Instances

Eq ValidateTemplateResponse

Methods

(==) :: ValidateTemplateResponse -> ValidateTemplateResponse -> Bool

(/=) :: ValidateTemplateResponse -> ValidateTemplateResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS ValidateTemplateResponse

readList :: ReadS [ValidateTemplateResponse]

readPrec :: ReadPrec ValidateTemplateResponse

readListPrec :: ReadPrec [ValidateTemplateResponse]

Show ValidateTemplateResponse

Methods

showsPrec :: Int -> ValidateTemplateResponse -> ShowS

show :: ValidateTemplateResponse -> String

showList :: [ValidateTemplateResponse] -> ShowS

Generic ValidateTemplateResponse

Associated Types

type Rep ValidateTemplateResponse :: * -> *

Methods

from :: ValidateTemplateResponse -> Rep ValidateTemplateResponse x

to :: Rep ValidateTemplateResponse x -> ValidateTemplateResponse

NFData ValidateTemplateResponse

Methods

rnf :: ValidateTemplateResponse -> ()

type Rep ValidateTemplateResponse

type Rep ValidateTemplateResponse = D1 * (MetaData "ValidateTemplateResponse" "Network.AWS.CloudFormation.ValidateTemplate" "amazonka-cloudformation-1.6.0-E2GV66prdF5G8DMBRBifWM" 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 DecidedStrict) (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.