policies

Creates, updates, deletes or gets a policy resource or lists policies in a region

Overview

Name	policies
Type	Resource
Description	Definition of AWS::VerifiedPermissions::Policy Resource Type
Id	awscc.verifiedpermissions.policies

Fields

get (all properties)

Name	Datatype	Description
definition	object
policy_id	string
policy_store_id	string
policy_type	string
region	string	AWS region.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	policies	INSERT	Definition, PolicyStoreId, region
delete_resource	policies	DELETE	Identifier, region
update_resource	policies	UPDATE	Identifier, PatchDocument, region
list_resources	policies_list_only	SELECT	region
get_resource	policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual policy.

SELECT
  region,
  definition,
  policy_id,
  policy_store_id,
  policy_type
FROM awscc.verifiedpermissions.policies
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ policy_id }}|{{ policy_store_id }}';

list (identifiers only)

Lists all policies in a region.

SELECT
  region,
  policy_id,
  policy_store_id
FROM awscc.verifiedpermissions.policies_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.verifiedpermissions.policies (
  Definition,
  PolicyStoreId,
  region
)
SELECT
  '{{ definition }}',
  '{{ policy_store_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.verifiedpermissions.policies (
  Definition,
  PolicyStoreId,
  region
)
SELECT
  '{{ definition }}',
  '{{ policy_store_id }}',
  '{{ region }}';

Manifest

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

UPDATE example

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

/*+ update */
UPDATE awscc.verifiedpermissions.policies
SET PatchDocument = string('{{ {
    "Definition": definition
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_id }}|{{ policy_store_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.verifiedpermissions.policies
WHERE
  Identifier = '{{ policy_id }}|{{ policy_store_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

verifiedpermissions:CreatePolicy,
verifiedpermissions:GetPolicy

Read

verifiedpermissions:GetPolicy

Update

verifiedpermissions:UpdatePolicy,
verifiedpermissions:GetPolicy

Delete

verifiedpermissions:DeletePolicy,
verifiedpermissions:GetPolicy

List

verifiedpermissions:ListPolicies,
verifiedpermissions:GetPolicy