registries

Creates, updates, deletes or gets a registry resource or lists registries in a region

Overview

Name	registries
Type	Resource
Description	Resource Type definition for AWS::EventSchemas::Registry
Id	aws.eventschemas.registries

Fields

Name	Datatype	Description
registry_name	string	The name of the schema registry.
description	string	A description of the registry to be created.
registry_arn	string	The ARN of the registry.
tags	array	Tags associated with the resource.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all registries in a region.

SELECT
region,
registry_name,
description,
registry_arn,
tags
FROM aws.eventschemas.registries
WHERE region = 'us-east-1';

Gets all properties from an individual registry.

SELECT
region,
registry_name,
description,
registry_arn,
tags
FROM aws.eventschemas.registries
WHERE region = 'us-east-1' AND data__Identifier = '<RegistryArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.eventschemas.registries (
 RegistryName,
 Description,
 Tags,
 region
)
SELECT 
'{{ RegistryName }}',
 '{{ Description }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.eventschemas.registries (
 RegistryName,
 Description,
 Tags,
 region
)
SELECT 
 '{{ RegistryName }}',
 '{{ Description }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: registry
    props:
      - name: RegistryName
        value: '{{ RegistryName }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.eventschemas.registries
WHERE data__Identifier = '<RegistryArn>'
AND region = 'us-east-1';

Permissions

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

Create

schemas:DescribeRegistry,
schemas:CreateRegistry,
schemas:TagResource

Read

schemas:DescribeRegistry

Update

schemas:DescribeRegistry,
schemas:UpdateRegistry,
schemas:TagResource,
schemas:UntagResource,
schemas:ListTagsForResource

Delete

schemas:DescribeRegistry,
schemas:DeleteRegistry

List

schemas:ListRegistries