Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFormation.ValidateTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data ValidateTemplate = ValidateTemplate' {
- templateBody :: Maybe Text
- templateURL :: Maybe Text
}
newValidateTemplate :: ValidateTemplate
validateTemplate_templateBody :: Lens' ValidateTemplate (Maybe Text)
validateTemplate_templateURL :: Lens' ValidateTemplate (Maybe Text)
data ValidateTemplateResponse = ValidateTemplateResponse' {
- capabilities :: Maybe [Capability]
- capabilitiesReason :: Maybe Text
- declaredTransforms :: Maybe [Text]
- description :: Maybe Text
- parameters :: Maybe [TemplateParameter]
- httpStatus :: Int
}
newValidateTemplateResponse :: Int -> ValidateTemplateResponse
validateTemplateResponse_capabilities :: Lens' ValidateTemplateResponse (Maybe [Capability])
validateTemplateResponse_capabilitiesReason :: Lens' ValidateTemplateResponse (Maybe Text)
validateTemplateResponse_declaredTransforms :: Lens' ValidateTemplateResponse (Maybe [Text])
validateTemplateResponse_description :: Lens' ValidateTemplateResponse (Maybe Text)
validateTemplateResponse_parameters :: Lens' ValidateTemplateResponse (Maybe [TemplateParameter])
validateTemplateResponse_httpStatus :: Lens' ValidateTemplateResponse Int

Creating a Request

data ValidateTemplate Source #

The input for ValidateTemplate action.

See: newValidateTemplate smart constructor.

Constructors

ValidateTemplate'

Fields

templateBody :: 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 CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
templateURL :: 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 or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Instances

Instances details

ToHeaders ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods toHeaders :: ValidateTemplate -> [Header] #
ToPath ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods toPath :: ValidateTemplate -> ByteString #
ToQuery ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods toQuery :: ValidateTemplate -> QueryString #
AWSRequest ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Associated Types type AWSResponse ValidateTemplate # Methods request :: (Service -> Service) -> ValidateTemplate -> Request ValidateTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ValidateTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ValidateTemplate))) #
Generic ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Associated Types type Rep ValidateTemplate :: Type -> Type # Methods from :: ValidateTemplate -> Rep ValidateTemplate x # to :: Rep ValidateTemplate x -> ValidateTemplate #
Read ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods readsPrec :: Int -> ReadS ValidateTemplate # readList :: ReadS [ValidateTemplate] # readPrec :: ReadPrec ValidateTemplate # readListPrec :: ReadPrec [ValidateTemplate] #
Show ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods showsPrec :: Int -> ValidateTemplate -> ShowS # show :: ValidateTemplate -> String # showList :: [ValidateTemplate] -> ShowS #
NFData ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods rnf :: ValidateTemplate -> () #
Eq ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods (==) :: ValidateTemplate -> ValidateTemplate -> Bool # (/=) :: ValidateTemplate -> ValidateTemplate -> Bool #
Hashable ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods hashWithSalt :: Int -> ValidateTemplate -> Int # hash :: ValidateTemplate -> Int #
type AWSResponse ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate type AWSResponse ValidateTemplate = ValidateTemplateResponse
type Rep ValidateTemplate Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate type Rep ValidateTemplate = D1 ('MetaData "ValidateTemplate" "Amazonka.CloudFormation.ValidateTemplate" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ValidateTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newValidateTemplate :: ValidateTemplate Source #

Create a value of ValidateTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ValidateTemplate, validateTemplate_templateBody - 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 CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

$sel:templateURL:ValidateTemplate', validateTemplate_templateURL - 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 or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Request Lenses

validateTemplate_templateBody :: Lens' ValidateTemplate (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, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

validateTemplate_templateURL :: Lens' ValidateTemplate (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 or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Destructuring the Response

data ValidateTemplateResponse Source #

The output for ValidateTemplate action.

See: newValidateTemplateResponse smart constructor.

Constructors

ValidateTemplateResponse'

Fields

capabilities :: Maybe [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 CloudFormation Templates.
capabilitiesReason :: Maybe Text
The list of resources that generated the values in the Capabilities response element.
declaredTransforms :: Maybe [Text]
A list of the transforms that are declared in the template.
description :: Maybe Text
The description found within the template.
parameters :: Maybe [TemplateParameter]
A list of TemplateParameter structures.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ValidateTemplateResponse Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Associated Types type Rep ValidateTemplateResponse :: Type -> Type # Methods from :: ValidateTemplateResponse -> Rep ValidateTemplateResponse x # to :: Rep ValidateTemplateResponse x -> ValidateTemplateResponse #
Read ValidateTemplateResponse Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods readsPrec :: Int -> ReadS ValidateTemplateResponse # readList :: ReadS [ValidateTemplateResponse] # readPrec :: ReadPrec ValidateTemplateResponse # readListPrec :: ReadPrec [ValidateTemplateResponse] #
Show ValidateTemplateResponse Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods showsPrec :: Int -> ValidateTemplateResponse -> ShowS # show :: ValidateTemplateResponse -> String # showList :: [ValidateTemplateResponse] -> ShowS #
NFData ValidateTemplateResponse Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods rnf :: ValidateTemplateResponse -> () #
Eq ValidateTemplateResponse Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate Methods (==) :: ValidateTemplateResponse -> ValidateTemplateResponse -> Bool # (/=) :: ValidateTemplateResponse -> ValidateTemplateResponse -> Bool #
type Rep ValidateTemplateResponse Source #
Instance details Defined in Amazonka.CloudFormation.ValidateTemplate type Rep ValidateTemplateResponse = D1 ('MetaData "ValidateTemplateResponse" "Amazonka.CloudFormation.ValidateTemplate" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ValidateTemplateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])) :: (S1 ('MetaSel ('Just "capabilitiesReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "declaredTransforms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TemplateParameter])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newValidateTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:ValidateTemplateResponse'`
-> ValidateTemplateResponse

Create a value of ValidateTemplateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ValidateTemplateResponse, validateTemplateResponse_capabilities - 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 CloudFormation Templates.

$sel:capabilitiesReason:ValidateTemplateResponse', validateTemplateResponse_capabilitiesReason - The list of resources that generated the values in the Capabilities response element.

$sel:declaredTransforms:ValidateTemplateResponse', validateTemplateResponse_declaredTransforms - A list of the transforms that are declared in the template.

ValidateTemplateResponse, validateTemplateResponse_description - The description found within the template.

ValidateTemplateResponse, validateTemplateResponse_parameters - A list of TemplateParameter structures.

$sel:httpStatus:ValidateTemplateResponse', validateTemplateResponse_httpStatus - The response's http status code.

Response Lenses

validateTemplateResponse_capabilities :: Lens' ValidateTemplateResponse (Maybe [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 CloudFormation Templates.

validateTemplateResponse_capabilitiesReason :: Lens' ValidateTemplateResponse (Maybe Text) Source #

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

validateTemplateResponse_declaredTransforms :: Lens' ValidateTemplateResponse (Maybe [Text]) Source #

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

validateTemplateResponse_description :: Lens' ValidateTemplateResponse (Maybe Text) Source #

The description found within the template.

validateTemplateResponse_parameters :: Lens' ValidateTemplateResponse (Maybe [TemplateParameter]) Source #

A list of TemplateParameter structures.

validateTemplateResponse_httpStatus :: Lens' ValidateTemplateResponse Int Source #

The response's http status code.