Skip to content

Get Template Summary

cloudformation_get_template_summary R Documentation

Returns information about a new or existing template

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 doesn't exist, a ValidationError is returned.

Usage

cloudformation_get_template_summary(TemplateBody, TemplateURL,
  StackName, StackSetName, CallAs, TemplateSummaryConfig)

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 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's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with ⁠https://⁠.

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

StackName

The name or the stack ID that's associated with the stack, which aren't 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.

CallAs

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

TemplateSummaryConfig

Specifies options for the get_template_summary API action.

Value

A list with the following syntax: 

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"
      )
    )
  ),
  Warnings = list(
    UnrecognizedResourceTypes = list(
      "string"
    )
  )
)

Request syntax

svc$get_template_summary(
  TemplateBody = "string",
  TemplateURL = "string",
  StackName = "string",
  StackSetName = "string",
  CallAs = "SELF"|"DELEGATED_ADMIN",
  TemplateSummaryConfig = list(
    TreatUnrecognizedResourceTypesAsWarnings = TRUE|FALSE
  )
)