AWS::EventSchemas::Registry

Use the AWS::EventSchemas::Registry to specify a schema registry. Schema registries are containers for Schemas. Registries collect and organize schemas so that your schemas are in logical groups.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EventSchemas::Registry",
  "Properties" : {
      "Description" : String,
      "RegistryName" : String,
      "Tags" : [ TagsEntry, ... ]
    }
}

YAML

Type: AWS::EventSchemas::Registry
Properties:
  Description: String
  RegistryName: String
  Tags: 
    - TagsEntry

Properties

Description

A description of the registry to be created.

Required: No

Type: String

Update requires: No interruption

RegistryName

The name of the schema registry.

Required: No

Type: String

Update requires: Replacement

Tags

Tags to associate with the registry.

Required: No

Type: Array of TagsEntry

Update requires: No interruption

Return values

Ref

When you provide the logical ID of this resource to the Ref intrinsic function, Ref returns the ARN of the schema. For example:

{ "Ref": "MyRegistry" }

Returns a value similar to the following:

arn:aws:schemas:us-east-1:012345678901:registry/MyRegistry

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

RegistryArn

The ARN of the registry.

RegistryName

The name of the registry.

Examples

Create a Schema Registry for Events Emitted by AWS Step Functions

YAML

Resources:
  StatesSchemasRegistry:
    Type: AWS::EventSchemas::Registry
    Properties:
      RegistryName: 'aws.states'
      Description: 'Contains the schemas of events emitted by AWS Step Functions'