Validate Template

cloudformation_validate_template

R Documentation

Validates a specified template

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.

Usage

cloudformation_validate_template(TemplateBody, TemplateURL)

Arguments

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.

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. The location for an Amazon S3 bucket must start with ⁠https://⁠.

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

Value

A list with the following syntax:

list(
  Parameters = list(
    list(
      ParameterKey = "string",
      DefaultValue = "string",
      NoEcho = TRUE|FALSE,
      Description = "string"
    )
  ),
  Description = "string",
  Capabilities = list(
    "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"
  ),
  CapabilitiesReason = "string",
  DeclaredTransforms = list(
    "string"
  )
)

Request syntax

svc$validate_template(
  TemplateBody = "string",
  TemplateURL = "string"
)