schema_versions

Creates, updates, deletes or gets a schema_version resource or lists schema_versions in a region

Overview

Name	schema_versions
Type	Resource
Description	This resource represents an individual schema version of a schema defined in Glue Schema Registry.
Id	awscc.glue.schema_versions

Fields

get (all properties)

Name	Datatype	Description
▶schema	object	Identifier for the schema where the schema version will be created.
schema_definition	string	Complete definition of the schema in plain-text.
version_id	string	Represents the version ID associated with the schema version.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
version_id	string	Represents the version ID associated with the schema version.
region	string	AWS region.

For more information, see AWS::Glue::SchemaVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	schema_versions	INSERT	Schema, SchemaDefinition, region
delete_resource	schema_versions	DELETE	Identifier, region
list_resources	schema_versions_list_only	SELECT	region
get_resource	schema_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual schema_version.

SELECT
  region,
  schema,
  schema_definition,
  version_id
FROM awscc.glue.schema_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ version_id }}';

list (identifiers only)

Lists all schema_versions in a region.

SELECT
  region,
  version_id
FROM awscc.glue.schema_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.glue.schema_versions (
  Schema,
  SchemaDefinition,
  region
)
SELECT
  '{{ schema }}',
  '{{ schema_definition }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.glue.schema_versions (
  Schema,
  SchemaDefinition,
  region
)
SELECT
  '{{ schema }}',
  '{{ schema_definition }}',
  '{{ 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_version
  props:
    - name: schema
      value:
        schema_arn: '{{ schema_arn }}'
        schema_name: '{{ schema_name }}'
        registry_name: '{{ registry_name }}'
    - name: schema_definition
      value: '{{ schema_definition }}'

DELETE example

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

Create

glue:RegisterSchemaVersion,
glue:GetSchemaVersion,
glue:GetSchemaByDefinition

Read

glue:GetSchemaVersion

Delete

glue:DeleteSchemaVersions,
glue:GetSchemaVersion

List

glue:ListSchemaVersions