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

The Amazon Resource Name (ARN) of the environment template.

descriptionstring

A description of the environment template.

display_namestring

The environment template name as displayed in the developer interface.

encryption_keystring

A customer provided encryption key that Proton uses to encrypt data.

namestring
provisioningstring
▶tagsarray

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.

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 = '{{ region }}' 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.proton.environment_templates
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

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