Describe Generated Template

cloudformation_describe_generated_template

R Documentation

Describes a generated template

Description

Describes a generated template. The output includes details about the progress of the creation of a generated template started by a create_generated_template API action or the update of a generated template started with an update_generated_template API action.

Usage

cloudformation_describe_generated_template(GeneratedTemplateName)

Arguments

GeneratedTemplateName

[required] The name or Amazon Resource Name (ARN) of a generated template.

Value

A list with the following syntax:

list(
  GeneratedTemplateId = "string",
  GeneratedTemplateName = "string",
  Resources = list(
    list(
      ResourceType = "string",
      LogicalResourceId = "string",
      ResourceIdentifier = list(
        "string"
      ),
      ResourceStatus = "PENDING"|"IN_PROGRESS"|"FAILED"|"COMPLETE",
      ResourceStatusReason = "string",
      Warnings = list(
        list(
          Type = "MUTUALLY_EXCLUSIVE_PROPERTIES"|"UNSUPPORTED_PROPERTIES"|"MUTUALLY_EXCLUSIVE_TYPES",
          Properties = list(
            list(
              PropertyPath = "string",
              Required = TRUE|FALSE,
              Description = "string"
            )
          )
        )
      )
    )
  ),
  Status = "CREATE_PENDING"|"UPDATE_PENDING"|"DELETE_PENDING"|"CREATE_IN_PROGRESS"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"FAILED"|"COMPLETE",
  StatusReason = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedTime = as.POSIXct(
    "2015-01-01"
  ),
  Progress = list(
    ResourcesSucceeded = 123,
    ResourcesFailed = 123,
    ResourcesProcessing = 123,
    ResourcesPending = 123
  ),
  StackId = "string",
  TemplateConfiguration = list(
    DeletionPolicy = "DELETE"|"RETAIN",
    UpdateReplacePolicy = "DELETE"|"RETAIN"
  ),
  TotalWarnings = 123
)

Request syntax

svc$describe_generated_template(
  GeneratedTemplateName = "string"
)

Examples

## Not run: 
# This example describes a generated template
svc$describe_generated_template(
  GeneratedTemplateName = "JazzyTemplate"
)

## End(Not run)