[ aws . serverlessrepo ]

get-cloud-formation-template

Description

Gets the specified AWS CloudFormation template.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-cloud-formation-template
--application-id <value>
--template-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--application-id (string)

The Amazon Resource Name (ARN) of the application.

--template-id (string)

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ApplicationId -> (string)

The application Amazon Resource Name (ARN).

CreationTime -> (string)

The date and time this resource was created.

ExpirationTime -> (string)

The date and time this template expires. Templates expire 1 hour after creation.

SemanticVersion -> (string)

The semantic version of the application:

https://semver.org/

Status -> (string)

Status of the template creation workflow.

Possible values: PREPARING | ACTIVE | EXPIRED

TemplateId -> (string)

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

TemplateUrl -> (string)

A link to the template that can be used to deploy the application using AWS CloudFormation.