Skip to main content

environment_templates

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

Overview​

Nameenvironment_templates
TypeResource
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Idawscc.proton.environment_templates

Fields​

NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the environment template.</p>
descriptionstring<p>A description of the environment template.</p>
display_namestring<p>The environment template name as displayed in the developer interface.</p>
encryption_keystring<p>A customer provided encryption key that Proton uses to encrypt data.</p>
namestring
provisioningstring
▶tagsarray<p>An optional list of metadata items that you can associate with the Proton environment 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::EnvironmentTemplate.

Methods​

NameResourceAccessible byRequired Params
create_resourceenvironment_templatesINSERTregion
delete_resourceenvironment_templatesDELETEIdentifier, region
update_resourceenvironment_templatesUPDATEIdentifier, PatchDocument, region
list_resourcesenvironment_templates_list_onlySELECTregion
get_resourceenvironment_templatesSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual environment_template.

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

INSERT example​

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

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

UPDATE example​

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

/*+ update */
UPDATE awscc.proton.environment_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.environment_templates
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions​

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

proton:CreateEnvironmentTemplate,
proton:DeleteEnvironmentTemplate,
proton:ListTagsForResource,
proton:TagResource,
proton:GetEnvironmentTemplate,
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