policy_stores

Creates, updates, deletes or gets a policy_store resource or lists policy_stores in a region

Overview

Name	policy_stores
Type	Resource
Description	Represents a policy store that you can place schema, policies, and policy templates in to validate authorization requests
Id	awscc.verifiedpermissions.policy_stores

Fields

get (all properties)

Name	Datatype	Description
arn	string
description	string
policy_store_id	string
▶validation_settings	object
schema	object
▶deletion_protection	object
▶tags	array	The tags to add to the policy store
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
policy_store_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	policy_stores	INSERT	ValidationSettings, region
delete_resource	policy_stores	DELETE	Identifier, region
update_resource	policy_stores	UPDATE	Identifier, PatchDocument, region
list_resources	policy_stores_list_only	SELECT	region
get_resource	policy_stores	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual policy_store.

SELECT
  region,
  arn,
  description,
  policy_store_id,
  validation_settings,
  schema,
  deletion_protection,
  tags
FROM awscc.verifiedpermissions.policy_stores
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_store_id }}';

list (identifiers only)

Lists all policy_stores in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.verifiedpermissions.policy_stores (
  ValidationSettings,
  region
)
SELECT
  '{{ validation_settings }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.verifiedpermissions.policy_stores (
  Description,
  ValidationSettings,
  Schema,
  DeletionProtection,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ validation_settings }}',
  '{{ schema }}',
  '{{ deletion_protection }}',
  '{{ tags }}',
  '{{ 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_store
  props:
    - name: description
      value: '{{ description }}'
    - name: validation_settings
      value:
        mode: '{{ mode }}'
    - name: schema
      value: null
    - name: deletion_protection
      value:
        mode: '{{ mode }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.verifiedpermissions.policy_stores
SET PatchDocument = string('{{ {
    "Description": description,
    "ValidationSettings": validation_settings,
    "Schema": schema,
    "DeletionProtection": deletion_protection,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ policy_store_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.verifiedpermissions.policy_stores
WHERE
  Identifier = '{{ policy_store_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_stores resource, the following permissions are required:

Create

verifiedpermissions:CreatePolicyStore,
verifiedpermissions:TagResource,
verifiedpermissions:GetPolicyStore,
verifiedpermissions:PutSchema

Read

verifiedpermissions:GetPolicyStore,
verifiedpermissions:ListTagsForResource,
verifiedpermissions:GetSchema

Update

verifiedpermissions:UpdatePolicyStore,
verifiedpermissions:GetPolicyStore,
verifiedpermissions:TagResource,
verifiedpermissions:UntagResource,
verifiedpermissions:GetSchema,
verifiedpermissions:PutSchema

Delete

verifiedpermissions:DeletePolicyStore,
verifiedpermissions:GetPolicyStore

List

verifiedpermissions:ListPolicyStores,
verifiedpermissions:GetPolicyStore,
verifiedpermissions:GetSchema