cloudformation_get_template_summary: Returns information about a new or existing template

Description Usage Arguments Value Request syntax

View source: R/cloudformation_operations.R

Description

Returns information about a new or existing template. The get_template_summary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the get_template_summary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, get_template_summary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

Usage

1
2
cloudformation_get_template_summary(TemplateBody, TemplateURL,
  StackName, StackSetName)

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 about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

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 about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

StackName

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

StackSetName

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

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
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
list(
  Parameters = list(
    list(
      ParameterKey = "string",
      DefaultValue = "string",
      ParameterType = "string",
      NoEcho = TRUE|FALSE,
      Description = "string",
      ParameterConstraints = list(
        AllowedValues = list(
          "string"
        )
      )
    )
  ),
  Description = "string",
  Capabilities = list(
    "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"
  ),
  CapabilitiesReason = "string",
  ResourceTypes = list(
    "string"
  ),
  Version = "string",
  Metadata = "string",
  DeclaredTransforms = list(
    "string"
  ),
  ResourceIdentifierSummaries = list(
    list(
      ResourceType = "string",
      LogicalResourceIds = list(
        "string"
      ),
      ResourceIdentifiers = list(
        "string"
      )
    )
  )
)

Request syntax

1
2
3
4
5
6
svc$get_template_summary(
  TemplateBody = "string",
  TemplateURL = "string",
  StackName = "string",
  StackSetName = "string"
)

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