Get Generated Template

cloudformation_get_generated_template

R Documentation

Retrieves a generated template¶

Description¶

Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.

Usage¶

cloudformation_get_generated_template(Format, GeneratedTemplateName)

Arguments¶

Format

The language to use to retrieve for the generated template. Supported values are:

JSON
YAML

GeneratedTemplateName

[required] The name or Amazon Resource Name (ARN) of the generated template. The format is ⁠arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}⁠. For example, ⁠arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc ⁠.

Value¶

A list with the following syntax:

list(
  Status = "CREATE_PENDING"|"UPDATE_PENDING"|"DELETE_PENDING"|"CREATE_IN_PROGRESS"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"FAILED"|"COMPLETE",
  TemplateBody = "string"
)

Request syntax¶

svc$get_generated_template(
  Format = "JSON"|"YAML",
  GeneratedTemplateName = "string"
)

Examples¶

## Not run: 
# This example gets a generated template ins JSON format.
svc$get_generated_template(
  GeneratedTemplateName = "JazzyTemplate"
)

# This example gets a generated template in YAML format.
svc$get_generated_template(
  Format = "YAML",
  GeneratedTemplateName = "JazzyTemplate"
)

## End(Not run)