# eb-schema

Part of **EB**

# EventBridge Event Tracing Console Guide

## Operations Overview

| Operation | Console Navigation | Prerequisites | Description |
|----------|-------------------|---------------|-------------|
| Create Schema | Console > EventBridge > Schemas > Cloud Registration tab > Create Schema | Activate EventBridge and grant permissions | Create a new schema with ID, description, content, and compatibility mode |
| View Schema | Console > EventBridge > Schemas > (Cloud/Custom) Registration tab > View | Activate EventBridge and grant permissions | View schema details including content and version list |
| Edit Schema | Console > EventBridge > Schemas > Cloud Registration tab > Edit | Activate EventBridge and grant permissions | Modify schema description or content |
| Delete Schema | Console > EventBridge > Schemas > Cloud Registration tab > Delete | Activate EventBridge and grant permissions | Permanently delete a schema (irreversible) |
| Create Schema Version | Console > EventBridge > Schemas > View > Schema Versions tab > Create Schema Version | Activate EventBridge and grant permissions | Register a new version of an existing schema |
| View Schema Version | Console > EventBridge > Schemas > View > Schema Versions tab > View | Activate EventBridge and grant permissions | Inspect definition and metadata of a specific schema version |
| Delete Schema Version | Console > EventBridge > Schemas > View > Schema Versions tab > Delete | Activate EventBridge and grant permissions | Remove a specific schema version (irreversible) |

## Operation Steps

### Create Schema

**Navigation**: Console > EventBridge > Schemas > Cloud Registration tab

**Prerequisites**:
- Activate EventBridge and grant permissions

1. Log on to the **EventBridge console**
   - Element: **EventBridge console** (link) — top navigation bar

2. In the left navigation panel, click **Schemas**
   - Element: **Schemas** (menu) — left navigation panel

3. In the top menu bar, select your target region
   - Element: **region dropdown** (dropdown) — top menu bar

4. On the Schemas page, click the **Cloud Registration** tab
   - Element: **Cloud Registration** (tab) — top of Schemas page

5. Click **Create Schema**
   - Element: **Create Schema** (button) — top of the Schemas page
   - Notes: A "Create Schema" panel opens

6. In the panel, enter the required information and click **OK**
   - Element: **OK** (button) — bottom of the Create Schema panel
   - Notes: The compatibility mode affects whether changes to schema fields are accepted across versions

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Schema ID | text_input | Yes | — | Unique identifier for the schema |
| Schema Description | text_input | No | — | Optional description of the schema |
| Schema Content | textarea | Yes | — | JSON or other format defining the schema structure |
| Compatibility Mode | dropdown | Yes | Backward, Forward, None | Determines how schema changes are handled across versions |

### View Schema

**Navigation**: Console > EventBridge > Schemas > (Cloud Registration or Custom Registration) tab

**Prerequisites**:
- Activate EventBridge and grant permissions

1. Navigate to the **Schemas** page as described in Create Schema steps 1–3

2. Click either the **Cloud Registration** or **Custom Registration** tab
   - Element: **Cloud Registration** / **Custom Registration** (tab) — top of Schemas page

3. Find your target schema in the table and click **View** in the Operations column
   - Element: **View** (button) — Operations column
   - Notes: The Schema Details page opens, showing basic info, schema content, and version list

### Edit Schema

**Navigation**: Console > EventBridge > Schemas > Cloud Registration tab

**Prerequisites**:
- Activate EventBridge and grant permissions
- Schema must be in Cloud Registration (custom schemas cannot be edited)

1. Navigate to the **Schemas** page and select the **Cloud Registration** tab

2. Find your target schema and click **Edit** in the Operations column
   - Element: **Edit** (button) — Operations column
   - Notes: An "Edit Schema" panel opens

3. Modify the **Schema Description** or **Schema Content**
   - Element: **Schema Description** (text_input), **Schema Content** (textarea)

4. Click **OK**
   - Element: **OK** (button) — bottom of the Edit Schema panel

### Delete Schema

**Navigation**: Console > EventBridge > Schemas > Cloud Registration tab

**Prerequisites**:
- Activate EventBridge and grant permissions

1. Navigate to the **Schemas** page and select the **Cloud Registration** tab

2. Find your target schema and click **Delete** in the Operations column
   - Element: **Delete** (button) — Operations column
   - Notes: A confirmation dialog appears; deleted schemas cannot be recovered

3. In the dialog, click **Confirm**
   - Element: **Confirm** (button) — dialog box

### Create Schema Version

**Navigation**: Console > EventBridge > Schemas > View > Schema Versions tab

**Prerequisites**:
- Activate EventBridge and grant permissions
- Target schema must already exist

1. Navigate to the **Schema Details** page by clicking **View** for your target schema

2. Click the **Schema Versions** tab
   - Element: **Schema Versions** (tab) — on Schema Details page

3. Click **Create Schema Version**
   - Element: **Create Schema Version** (button) — top of the Schema Versions tab
   - Notes: A "Create Schema Version" panel opens

4. Enter the **Content** for the new version
   - Element: **Content** (textarea) — in the panel

5. Click **OK**
   - Element: **OK** (button) — bottom of the Create Schema Version panel

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Content | textarea | Yes | — | Definition of the new schema version |

### View Schema Version

**Navigation**: Console > EventBridge > Schemas > View > Schema Versions tab

**Prerequisites**:
- Activate EventBridge and grant permissions
- Target schema version must exist

1. Go to the **Schema Details** page for your schema

2. Click the **Schema Versions** tab

3. Find the target version and click **View** in the Operations column
   - Element: **View** (button) — Operations column
   - Notes: The Schema Version Details page shows basic info and version definition

### Delete Schema Version

**Navigation**: Console > EventBridge > Schemas > View > Schema Versions tab

**Prerequisites**:
- Activate EventBridge and grant permissions

1. Go to the **Schema Details** page and open the **Schema Versions** tab

2. Find the target version and click **Delete** in the Operations column
   - Element: **Delete** (button) — Operations column
   - Notes: A confirmation dialog appears; deleted versions cannot be recovered

3. Click **Confirm** in the dialog
   - Element: **Confirm** (button) — dialog box

## FAQ

Q: Can I edit a schema registered under Custom Registration?
A: No. Only schemas in the Cloud Registration tab can be edited. Custom Registration schemas are read-only.

Q: What happens if I delete a schema?
A: The schema and all its versions are permanently deleted and cannot be recovered. Ensure no event rules or applications depend on it.

Q: Where do I find the schema content after creation?
A: Click **View** in the Operations column on the Schemas page. The schema content is displayed on the Schema Details page.

Q: What compatibility modes are available, and what do they mean?
A: Options are **Backward**, **Forward**, and **None**. Backward allows new versions to accept data from older versions. Forward allows old versions to accept data from newer ones. None enforces strict equality.

Q: Can I modify a schema version after it’s created?
A: No. Schema versions are immutable. To update, create a new version with modified content.

## Pricing & Billing

### Billing Model
Schema management operations are free of charge.

### Free Tier
No cost for creating, viewing, editing, or deleting schemas in EventBridge.

### Billing Notes
Schema management operations are free of charge. No billing applies for schema creation, deletion, or versioning.