schemata

Creates, updates, deletes or gets a schema resource or lists schemata in a region

Overview

Name	schemata
Type	Resource
Description	Resource Type definition for AWS::EventSchemas::Schema
Id	aws.eventschemas.schemata

Fields

Name	Datatype	Description
type	string	The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
description	string	A description of the schema.
schema_version	string	The version number of the schema.
content	string	The source of the schema definition.
registry_name	string	The name of the schema registry.
schema_arn	string	The ARN of the schema.
schema_name	string	The name of the schema.
last_modified	string	The last modified time of the schema.
version_created_date	string	The date the schema version was created.
tags	array	Tags associated with the resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Type, Content, RegistryName, 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 schemata in a region.

SELECT
region,
type,
description,
schema_version,
content,
registry_name,
schema_arn,
schema_name,
last_modified,
version_created_date,
tags
FROM aws.eventschemas.schemata
WHERE region = 'us-east-1';

Gets all properties from an individual schema.

SELECT
region,
type,
description,
schema_version,
content,
registry_name,
schema_arn,
schema_name,
last_modified,
version_created_date,
tags
FROM aws.eventschemas.schemata
WHERE region = 'us-east-1' AND data__Identifier = '<SchemaArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.eventschemas.schemata (
 Type,
 Content,
 RegistryName,
 region
)
SELECT 
'{{ Type }}',
 '{{ Content }}',
 '{{ RegistryName }}',
'{{ region }}';

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

schemas:DescribeSchema,
schemas:CreateSchema,
schemas:TagResource

Read

schemas:DescribeSchema

Update

schemas:DescribeSchema,
schemas:UpdateSchema,
schemas:TagResource,
schemas:UntagResource,
schemas:ListTagsForResource

Delete

schemas:DescribeSchema,
schemas:DeleteSchema,
schemas:DeleteSchemaVersion

List

schemas:ListSchemas,
schemas:ListSchemaVersions