policy_templates

Creates, updates, deletes or gets a policy_template resource or lists policy_templates in a region

Overview

Name	policy_templates
Type	Resource
Description	Definition of AWS::VerifiedPermissions::PolicyTemplate Resource Type
Id	awscc.verifiedpermissions.policy_templates

Fields

get (all properties)

Name	Datatype	Description
description	string
policy_store_id	string
policy_template_id	string
statement	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
policy_store_id	string
policy_template_id	string
region	string	AWS region.

For more information, see AWS::VerifiedPermissions::PolicyTemplate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	policy_templates	INSERT	Statement, PolicyStoreId, region
delete_resource	policy_templates	DELETE	Identifier, region
update_resource	policy_templates	UPDATE	Identifier, PatchDocument, region
list_resources	policy_templates_list_only	SELECT	region
get_resource	policy_templates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual policy_template.

SELECT
  region,
  description,
  policy_store_id,
  policy_template_id,
  statement
FROM awscc.verifiedpermissions.policy_templates
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_store_id }}|{{ policy_template_id }}';

list (identifiers only)

Lists all policy_templates in a region.

SELECT
  region,
  policy_store_id,
  policy_template_id
FROM awscc.verifiedpermissions.policy_templates_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.verifiedpermissions.policy_templates (
  PolicyStoreId,
  Statement,
  region
)
SELECT
  '{{ policy_store_id }}',
  '{{ statement }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.verifiedpermissions.policy_templates (
  Description,
  PolicyStoreId,
  Statement,
  region
)
SELECT
  '{{ description }}',
  '{{ policy_store_id }}',
  '{{ statement }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: policy_template
  props:
    - name: description
      value: '{{ description }}'
    - name: policy_store_id
      value: '{{ policy_store_id }}'
    - name: statement
      value: '{{ statement }}'

UPDATE example

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

/*+ update */
UPDATE awscc.verifiedpermissions.policy_templates
SET PatchDocument = string('{{ {
    "Description": description,
    "Statement": statement
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_store_id }}|{{ policy_template_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.verifiedpermissions.policy_templates
WHERE
  Identifier = '{{ policy_store_id }}|{{ policy_template_id }}' 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:

Parameter	Description
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 policy_templates resource, the following permissions are required:

Create

verifiedpermissions:CreatePolicyTemplate,
verifiedpermissions:GetPolicyTemplate

Read

verifiedpermissions:GetPolicyTemplate

Update

verifiedpermissions:UpdatePolicyTemplate,
verifiedpermissions:GetPolicyTemplate

Delete

verifiedpermissions:DeletePolicyTemplate,
verifiedpermissions:GetPolicyTemplate

List

verifiedpermissions:ListPolicyTemplates,
verifiedpermissions:GetPolicyTemplate