registry_policies

Creates, updates, deletes or gets a registry_policy resource or lists registry_policies in a region

Overview

Name	registry_policies
Type	Resource
Description	Resource Type definition for AWS::EventSchemas::RegistryPolicy
Id	awscc.eventschemas.registry_policies

Fields

Name	Datatype	Description
id	string
policy	object
registry_name	string
revision_id	string
region	string	AWS region.

For more information, see AWS::EventSchemas::RegistryPolicy.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RegistryName, Policy, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual registry_policy.

SELECT
  region,
  id,
  policy,
  registry_name,
  revision_id
FROM awscc.eventschemas.registry_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.eventschemas.registry_policies (
  Policy,
  RegistryName,
  region
)
SELECT
  '{{ policy }}',
  '{{ registry_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.eventschemas.registry_policies (
  Policy,
  RegistryName,
  RevisionId,
  region
)
SELECT
  '{{ policy }}',
  '{{ registry_name }}',
  '{{ revision_id }}',
  '{{ 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: registry_policy
  props:
    - name: policy
      value: {}
    - name: registry_name
      value: '{{ registry_name }}'
    - name: revision_id
      value: '{{ revision_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.eventschemas.registry_policies
SET PatchDocument = string('{{ {
    "Policy": policy,
    "RegistryName": registry_name,
    "RevisionId": revision_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

schemas:PutResourcePolicy,
schemas:GetResourcePolicy,
schemas:DescribeRegistry

Delete

schemas:DeleteResourcePolicy,
schemas:GetResourcePolicy

Update

schemas:PutResourcePolicy,
schemas:GetResourcePolicy

Read

schemas:GetResourcePolicy