cloudformation_get_template: Returns the template body for a specified stack

Description Usage Arguments Value Request syntax

View source: R/cloudformation_operations.R

Description

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template does not exist, a ValidationError is returned.

Usage

1
cloudformation_get_template(StackName, ChangeSetName, TemplateStage)

Arguments

StackName

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

ChangeSetName

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

TemplateStage

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Value

A list with the following syntax:

1
2
3
4
5
6
list(
  TemplateBody = "string",
  StagesAvailable = list(
    "Original"|"Processed"
  )
)

Request syntax

1
2
3
4
5
svc$get_template(
  StackName = "string",
  ChangeSetName = "string",
  TemplateStage = "Original"|"Processed"
)

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