environment_templates

Creates, updates, deletes, gets or lists an environment_templates resource.

Overview

Name	environment_templates
Type	Resource
Id	aws.proton.environment_templates

Fields

The following fields are returned by SELECT queries:

get_environment_template

Name	Datatype	Description
name	string	The name of the environment template. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
arn	string	The Amazon Resource Name (ARN) of the environment template.
created_at	string (date-time)	The time when the environment template was created.
description	string	A description of the environment template.
display_name	string	The name of the environment template as displayed in the developer interface.
encryption_key	string	The customer provided encryption key for the environment template. (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 environment template was last modified.
provisioning	string	When included, indicates that the environment template is for customer provisioned and managed infrastructure. (CUSTOMER_MANAGED)
recommended_version	string	The ID of the recommended version of the environment template. (pattern: <code>^(0|([1-9]{1}\d*)).(0|([1-9]{1}\d*))$</code>)

list_environment_templates

Name	Datatype	Description
name	string	The name of the environment template. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)
arn	string	The Amazon Resource Name (ARN) of the environment template.
created_at	string (date-time)	The time when the environment template was created.
description	string	A description of the environment template.
display_name	string	The name of the environment template as displayed in the developer interface.
last_modified_at	string (date-time)	The time when the environment template was last modified.
provisioning	string	When included, indicates that the environment template is for customer provisioned and managed infrastructure. (CUSTOMER_MANAGED)
recommended_version	string	The recommended version of the environment 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_environment_template	select	region		Get detailed data for an environment template.
list_environment_templates	select	region		List environment templates.
create_environment_template	insert	region, name		Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide. You can create an environment template in one of the two following ways: Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure. Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the Proton User Guide.
update_environment_template	update	region, name		Update an environment template.
delete_environment_template	delete	region		If no other major or minor versions of an environment template exist, delete the environment 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_environment_template

Get detailed data for an environment template.

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

list_environment_templates

List environment templates.

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

INSERT examples

create_environment_template

Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide. You can create an environment template in one of the two following ways: Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure. Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the Proton User Guide.

INSERT INTO aws.proton.environment_templates (
description,
displayName,
encryptionKey,
name,
provisioning,
tags,
region
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ encryptionKey }}',
'{{ name }}' /* required */,
'{{ provisioning }}',
'{{ tags }}',
'{{ region }}'
RETURNING
environment_template
;

Manifest

# Description fields are for documentation purposes
- name: environment_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environment_templates resource.
  - name: description
    value: "{{ description }}"
    description: |
      A description of the environment template.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The environment template name as displayed in the developer interface.
  - name: encryptionKey
    value: "{{ encryptionKey }}"
    description: |
      A customer provided encryption key that Proton uses to encrypt data.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the environment template.
  - name: provisioning
    value: "{{ provisioning }}"
    description: |
      When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    valid_values: ['CUSTOMER_MANAGED']
  - name: tags
    description: |
      An optional list of metadata items that you can associate with the Proton environment 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_environment_template

Update an environment template.

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

DELETE examples

delete_environment_template

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

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