cloud_formation_templates

Creates, updates, deletes, gets or lists a cloud_formation_templates resource.

Overview

Name	cloud_formation_templates
Type	Resource
Id	aws.serverlessrepo.cloud_formation_templates

Fields

The following fields are returned by SELECT queries:

get_cloud_formation_template

Name	Datatype	Description
application_id	string	The application Amazon Resource Name (ARN).
creation_time	string	The date and time this resource was created.
expiration_time	string	The date and time this template expires. Templates expire 1 hour after creation.
semantic_version	string	The semantic version of the application: https:​//semver.org/
status	string	Status of the template creation workflow. Possible values: PREPARING | ACTIVE | EXPIRED (PREPARING, ACTIVE, EXPIRED)
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}
template_url	string	A link to the template that can be used to deploy the application using AWS CloudFormation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cloud_formation_template	select	application_id, template_id, region		Gets the specified AWS CloudFormation template.
create_cloud_formation_template	insert	application_id, region		Creates an AWS CloudFormation template.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The Amazon Resource Name (ARN) of the application.
region	string	AWS region (default: us-east-1)
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}

SELECT examples

get_cloud_formation_template

Gets the specified AWS CloudFormation template.

SELECT
application_id,
creation_time,
expiration_time,
semantic_version,
status,
template_id,
template_url
FROM aws.serverlessrepo.cloud_formation_templates
WHERE application_id = '{{ application_id }}' -- required
AND template_id = '{{ template_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_cloud_formation_template

Creates an AWS CloudFormation template.

INSERT INTO aws.serverlessrepo.cloud_formation_templates (
SemanticVersion,
application_id,
region
)
SELECT 
'{{ SemanticVersion }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
application_id,
creation_time,
expiration_time,
semantic_version,
status,
template_id,
template_url
;

Manifest

# Description fields are for documentation purposes
- name: cloud_formation_templates
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the cloud_formation_templates resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cloud_formation_templates resource.
  - name: SemanticVersion
    value: "{{ SemanticVersion }}"