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	awscc.eventschemas.registries

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
registry_arn	string	The ARN of the registry.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	registries	INSERT	region
delete_resource	registries	DELETE	Identifier, region
update_resource	registries	UPDATE	Identifier, PatchDocument, region
list_resources	registries_list_only	SELECT	region
get_resource	registries	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual registry.

SELECT
  region,
  registry_name,
  description,
  registry_arn,
  tags
FROM awscc.eventschemas.registries
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ registry_arn }}';

list (identifiers only)

Lists all registries in a region.

SELECT
  region,
  registry_arn
FROM awscc.eventschemas.registries_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.eventschemas.registries (
  RegistryName,
  Description,
  Tags,
  region
)
SELECT
  '{{ registry_name }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.eventschemas.registries (
  RegistryName,
  Description,
  Tags,
  region
)
SELECT
  '{{ registry_name }}',
  '{{ description }}',
  '{{ 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: registry
  props:
    - name: registry_name
      value: '{{ registry_name }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.eventschemas.registries
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ registry_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.eventschemas.registries
WHERE
  Identifier = '{{ registry_arn }}' 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 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