Skip to main content

service_templates

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

Overview​

Nameservice_templates
TypeResource
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Idawscc.proton.service_templates

Fields​

NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the service template.</p>
descriptionstring<p>A description of the service template.</p>
display_namestring<p>The name of the service template as displayed in the developer interface.</p>
encryption_keystring<p>A customer provided encryption key that's used to encrypt data.</p>
namestring
pipeline_provisioningstring
▶tagsarray<p>An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.</p><br /><p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the<br /><i>Proton User Guide</i>.</p>
regionstringAWS region.

For more information, see AWS::Proton::ServiceTemplate.

Methods​

NameResourceAccessible byRequired Params
create_resourceservice_templatesINSERTregion
delete_resourceservice_templatesDELETEIdentifier, region
update_resourceservice_templatesUPDATEIdentifier, PatchDocument, region
list_resourcesservice_templates_list_onlySELECTregion
get_resourceservice_templatesSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual service_template.

SELECT
  region,
  arn,
  description,
  display_name,
  encryption_key,
  name,
  pipeline_provisioning,
  tags
FROM awscc.proton.service_templates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

INSERT example​

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

/*+ create */
INSERT INTO awscc.proton.service_templates (
  Description,
  DisplayName,
  EncryptionKey,
  Name,
  PipelineProvisioning,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ display_name }}',
  '{{ encryption_key }}',
  '{{ name }}',
  '{{ pipeline_provisioning }}',
  '{{ tags }}',
  '{{ region }}';

UPDATE example​

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

/*+ update */
UPDATE awscc.proton.service_templates
SET PatchDocument = string('{{ {
    "Description": description,
    "DisplayName": display_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example​

/*+ delete */
DELETE FROM awscc.proton.service_templates
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions​

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

proton:CreateServiceTemplate,
proton:TagResource,
proton:GetServiceTemplate,
kms:CancelKeyDeletion,
kms:CreateAlias,
kms:CreateCustomKeyStore,
kms:CreateGrant,
kms:CreateKey,
kms:DeleteAlias,
kms:DeleteCustomKeyStore,
kms:DeleteImportedKeyMaterial,
kms:DescribeCustomKeyStores,
kms:DescribeKey,
kms:DisableKey,
kms:DisableKeyRotation,
kms:EnableKey,
kms:EnableKeyRotation,
kms:GenerateDataKey,
kms:GetKeyPolicy,
kms:GetKeyRotationStatus,
kms:GetParametersForImport,
kms:GetPublicKey,
kms:ListAliases,
kms:ListGrants,
kms:ListKeyPolicies,
kms:ListKeyRotations,
kms:ListKeys,
kms:ListResourceTags,
kms:ListRetirableGrants,
kms:PutKeyPolicy,
kms:RevokeGrant,
kms:ScheduleKeyDeletion,
kms:TagResource,
kms:UntagResource,
kms:UpdateAlias,
kms:UpdateCustomKeyStore,
kms:UpdateKeyDescription,
kms:UpdatePrimaryRegion