Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- validateTemplate :: ValidateTemplate
- data ValidateTemplate
- vtTemplateBody :: Lens' ValidateTemplate (Maybe Text)
- vtTemplateURL :: Lens' ValidateTemplate (Maybe Text)
- validateTemplateResponse :: Int -> ValidateTemplateResponse
- data ValidateTemplateResponse
- vtrsDeclaredTransforms :: Lens' ValidateTemplateResponse [Text]
- vtrsCapabilitiesReason :: Lens' ValidateTemplateResponse (Maybe Text)
- vtrsParameters :: Lens' ValidateTemplateResponse [TemplateParameter]
- vtrsDescription :: Lens' ValidateTemplateResponse (Maybe Text)
- vtrsCapabilities :: Lens' ValidateTemplateResponse [Capability]
- vtrsResponseStatus :: Lens' ValidateTemplateResponse Int
Creating a Request
validateTemplate :: ValidateTemplate Source #
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 passTemplateURL
orTemplateBody
. If both are passed, onlyTemplateBody
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 passTemplateURL
orTemplateBody
. If both are passed, onlyTemplateBody
is used.
data ValidateTemplate Source #
The input for ValidateTemplate
action.
See: validateTemplate
smart constructor.
Request Lenses
vtTemplateBody :: 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 AWS CloudFormation User Guide. Conditional: You must pass TemplateURL
or TemplateBody
. If both are passed, only TemplateBody
is used.
vtTemplateURL :: 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. 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 Source #
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 theCapabilities
response element.vtrsParameters
- A list ofTemplateParameter
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 theCreateStack
orUpdateStack
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 Source #
The output for ValidateTemplate
action.
See: validateTemplateResponse
smart constructor.
Response Lenses
vtrsDeclaredTransforms :: Lens' ValidateTemplateResponse [Text] Source #
A list of the transforms that are declared in the template.
vtrsCapabilitiesReason :: Lens' ValidateTemplateResponse (Maybe Text) Source #
The list of resources that generated the values in the Capabilities
response element.
vtrsParameters :: Lens' ValidateTemplateResponse [TemplateParameter] Source #
A list of TemplateParameter
structures.
vtrsDescription :: Lens' ValidateTemplateResponse (Maybe Text) Source #
The description found within the template.
vtrsCapabilities :: Lens' ValidateTemplateResponse [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 .
vtrsResponseStatus :: Lens' ValidateTemplateResponse Int Source #
- - | The response status code.