environment_templates

Creates, updates, deletes or gets an environment_template resource or lists environment_templates in a region

Overview

Name	environment_templates
Type	Resource
Description	Definition of AWS::Proton::EnvironmentTemplate Resource Type
Id	aws.proton.environment_templates

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the environment template.
description	string	A description of the environment template.
display_name	string	The environment template name as displayed in the developer interface.
encryption_key	string	A customer provided encryption key that Proton uses to encrypt data.
name	string
provisioning	string
tags	array	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.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all environment_templates in a region.

SELECT
region,
arn,
description,
display_name,
encryption_key,
name,
provisioning,
tags
FROM aws.proton.environment_templates
WHERE region = 'us-east-1';

Gets all properties from an individual environment_template.

SELECT
region,
arn,
description,
display_name,
encryption_key,
name,
provisioning,
tags
FROM aws.proton.environment_templates
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new environment_template resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.proton.environment_templates (
 Description,
 DisplayName,
 EncryptionKey,
 Name,
 Provisioning,
 Tags,
 region
)
SELECT 
'{{ Description }}',
 '{{ DisplayName }}',
 '{{ EncryptionKey }}',
 '{{ Name }}',
 '{{ Provisioning }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.proton.environment_templates (
 Description,
 DisplayName,
 EncryptionKey,
 Name,
 Provisioning,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ EncryptionKey }}',
 '{{ Name }}',
 '{{ Provisioning }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: environment_template
    props:
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: EncryptionKey
        value: '{{ EncryptionKey }}'
      - name: Name
        value: '{{ Name }}'
      - name: Provisioning
        value: '{{ Provisioning }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.proton.environment_templates
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the environment_templates resource, the following permissions are required:

Create

proton:CreateEnvironmentTemplate,
proton:TagResource,
proton:GetEnvironmentTemplate,
kms:*

Read

proton:GetEnvironmentTemplate,
proton:ListTagsForResource,
kms:*

Update

proton:CreateEnvironmentTemplate,
proton:ListTagsForResource,
proton:TagResource,
proton:UntagResource,
proton:UpdateEnvironmentTemplate,
proton:GetEnvironmentTemplate,
kms:*

Delete

proton:DeleteEnvironmentTemplate,
proton:GetEnvironmentTemplate,
kms:*

List

proton:ListEnvironmentTemplates