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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
schema_arn	string	The ARN of the schema.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	schemata	INSERT	Type, Content, RegistryName, region
delete_resource	schemata	DELETE	Identifier, region
update_resource	schemata	UPDATE	Identifier, PatchDocument, region
list_resources	schemata_list_only	SELECT	region
get_resource	schemata	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.eventschemas.schemata
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ schema_arn }}';

list (identifiers only)

Lists all schemata in a region.

SELECT
  region,
  schema_arn
FROM awscc.eventschemas.schemata_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.eventschemas.schemata (
  Type,
  Content,
  RegistryName,
  region
)
SELECT
  '{{ type }}',
  '{{ content }}',
  '{{ registry_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.eventschemas.schemata (
  Type,
  Description,
  Content,
  RegistryName,
  SchemaName,
  Tags,
  region
)
SELECT
  '{{ type }}',
  '{{ description }}',
  '{{ content }}',
  '{{ registry_name }}',
  '{{ schema_name }}',
  '{{ 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: schema
  props:
    - name: type
      value: '{{ type }}'
    - name: description
      value: '{{ description }}'
    - name: content
      value: '{{ content }}'
    - name: registry_name
      value: '{{ registry_name }}'
    - name: schema_name
      value: '{{ schema_name }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

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

DELETE example

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