cloudformation_validate_template: Validates a specified template

Description Usage Arguments Value Request syntax

View source: R/cloudformation_operations.R

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.

Usage

1
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 AWS 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. 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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
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

1
2
3
4
svc$validate_template(
  TemplateBody = "string",
  TemplateURL = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.