service_templates

Creates, updates, deletes or gets a service_template resource or lists service_templates in a region

Overview

Name	service_templates
Type	Resource
Description	Definition of AWS::Proton::ServiceTemplate Resource Type
Id	aws.proton.service_templates

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the service template.
description	string	A description of the service template.
display_name	string	The name of the service template as displayed in the developer interface.
encryption_key	string	A customer provided encryption key that's used to encrypt data.
name	string
pipeline_provisioning	string
tags	array	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.
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 service_templates in a region.

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

Gets all properties from an individual service_template.

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

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

proton:CreateServiceTemplate,
proton:TagResource,
kms:*,
proton:GetServiceTemplate

Read

proton:GetServiceTemplate,
proton:ListTagsForResource,
kms:*

Update

proton:GetServiceTemplate,
proton:CreateServiceTemplate,
proton:ListTagsForResource,
proton:TagResource,
proton:UntagResource,
proton:UpdateServiceTemplate,
kms:*

Delete

proton:DeleteServiceTemplate,
proton:UntagResource,
kms:*,
proton:GetServiceTemplate

List

proton:ListServiceTemplates