service_templates

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

Overview

Name	service_templates
Type	Resource
Id	aws.proton.service_templates

Fields

The following fields are returned by SELECT queries:

get_service_template

Name	Datatype	Description
name	string	The name of the service template. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
arn	string	The Amazon Resource Name (ARN) of the service template.
created_at	string (date-time)	The time when the service template was created.
description	string	A description of the service template.
display_name	string	The service template name as displayed in the developer interface.
encryption_key	string	The customer provided service template encryption key that's used to encrypt data. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]:\d{12}:([\w+=,.@-]+[/:])[\w+=,.@-]+$</code>)
last_modified_at	string (date-time)	The time when the service template was last modified.
pipeline_provisioning	string	If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template. (CUSTOMER_MANAGED)
recommended_version	string	The recommended version of the service template. (pattern: <code>^(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))$</code>)

list_service_templates

Name	Datatype	Description
name	string	The name of the service template. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
arn	string	The Amazon Resource Name (ARN) of the service template.
created_at	string (date-time)	The time when the service template was created.
description	string	A description of the service template.
display_name	string	The service template name as displayed in the developer interface.
last_modified_at	string (date-time)	The time when the service template was last modified.
pipeline_provisioning	string	If pipelineProvisioning is true, a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template. (CUSTOMER_MANAGED)
recommended_version	string	The recommended version of the service template. (pattern: <code>^(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_template	select	region		Get detailed data for a service template.
list_service_templates	select	region		List service templates with detail data.
create_service_template	insert	region, name		Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Proton templates in the Proton User Guide.
update_service_template	update	region, name		Update a service template.
delete_service_template	delete	region		If no other major or minor versions of the service template exist, delete the service 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
region	string	AWS region (default: us-east-1)

SELECT examples

get_service_template

Get detailed data for a service template.

SELECT
name,
arn,
created_at,
description,
display_name,
encryption_key,
last_modified_at,
pipeline_provisioning,
recommended_version
FROM aws.proton.service_templates
WHERE region = '{{ region }}' -- required
;

list_service_templates

List service templates with detail data.

SELECT
name,
arn,
created_at,
description,
display_name,
last_modified_at,
pipeline_provisioning,
recommended_version
FROM aws.proton.service_templates
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_service_template

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Proton templates in the Proton User Guide.

INSERT INTO aws.proton.service_templates (
description,
displayName,
encryptionKey,
name,
pipelineProvisioning,
tags,
region
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ encryptionKey }}',
'{{ name }}' /* required */,
'{{ pipelineProvisioning }}',
'{{ tags }}',
'{{ region }}'
RETURNING
service_template
;

Manifest

# Description fields are for documentation purposes
- name: service_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the service_templates resource.
  - name: description
    value: "{{ description }}"
    description: |
      A description of the service template.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The name of the service template as displayed in the developer interface.
  - name: encryptionKey
    value: "{{ encryptionKey }}"
    description: |
      A customer provided encryption key that's used to encrypt data.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the service template.
  - name: pipelineProvisioning
    value: "{{ pipelineProvisioning }}"
    description: |
      By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.
    valid_values: ['CUSTOMER_MANAGED']
  - name: tags
    description: |
      An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair. For more information, see Proton resources and tagging in the Proton User Guide.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_service_template

Update a service template.

UPDATE aws.proton.service_templates
SET 
description = '{{ description }}',
displayName = '{{ displayName }}',
name = '{{ name }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
RETURNING
service_template;

DELETE examples

delete_service_template

If no other major or minor versions of the service template exist, delete the service template.

DELETE FROM aws.proton.service_templates
WHERE region = '{{ region }}' --required
;