View a markdown version of this page

AWS::AgentRegistry::RegistryRecord - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::AgentRegistry::RegistryRecord

The AWS::AgentRegistry::RegistryRecord resource specifies a registry record within a registry. A registry record describes a discoverable resource, such as a Model Context Protocol (MCP) server, an agent, an agent skill, or a custom resource.

Syntax

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

JSON

{
  "Type" : "AWS::AgentRegistry::RegistryRecord",
  "Properties" : {
      "CustomMetadata" : Json,
      "Description" : String,
      "Descriptors" : Descriptors,
      "DisplayName" : String,
      "Name" : String,
      "RecordType" : String,
      "RecordVersion" : String,
      "RegistryId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::AgentRegistry::RegistryRecord
Properties:
  CustomMetadata: Json
  Description: String
  Descriptors: 
    Descriptors
  DisplayName: String
  Name: String
  RecordType: String
  RecordVersion: String
  RegistryId: String
  Tags: 
    - Tag

Properties

CustomMetadata

The custom metadata to attach to the registry record, as a free-form JSON object. Each key must match a property that's defined in the registry's custom metadata schema. Each value must be a string of up to 128 characters, or a JSON boolean (true or false).

If you remove this property from the template during a stack update, the existing custom metadata isn't cleared. The service keeps the current metadata.

Required: No

Type: Json

Update requires: No interruption

Description

The description of the registry record.

Required: No

Type: String

Minimum: 1

Maximum: 4096

Update requires: No interruption

Descriptors

The typed descriptor content for the registry record. Exactly one descriptor field is populated based on the record type.

The McpServer descriptor is for the MCP record type. The AgentSkillsDefinition descriptor is for the SKILL record type. The Custom descriptor is for the CUSTOM record type. For the AGENT record type, use the A2aAgentCard, Http, or Agui descriptor.

Required: Yes

Type: Descriptors

Update requires: No interruption

DisplayName

The human-readable display name of the registry record.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Name

The name of the registry record. Names are unique within a registry.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_\-\.\/]*$

Minimum: 1

Maximum: 255

Update requires: No interruption

RecordType

The type of the registry record, which determines the descriptor format. Valid values are:

  • MCP – The record describes a Model Context Protocol (MCP) server. Use the McpServer descriptor.

  • AGENT – The record describes an agent. Use the A2aAgentCard, Http, or Agui descriptor.

  • SKILL – The record describes an agent skill. Use the AgentSkillsDefinition descriptor.

  • CUSTOM – The record describes a custom resource. Use the Custom descriptor.

  • GATEWAY – The record describes a gateway.

Required: Yes

Type: String

Allowed values: MCP | AGENT | SKILL | CUSTOM | GATEWAY

Update requires: Replacement

RecordVersion

The version of the registry record.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9.-]+$

Minimum: 1

Maximum: 255

Update requires: No interruption

RegistryId

The identifier of the registry in which to create the record. You can specify either the registry ID or the registry Amazon Resource Name (ARN). To reference a registry that another account shares with you through AWS Resource Access Manager (AWS RAM), use the ARN.

Required: No

Type: String

Pattern: ^(arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}$

Minimum: 1

Maximum: 2048

Update requires: Replacement

Tags

A list of key-value pairs that contain metadata for the registry record. For more information, see Tagging AWS resources in the AWS General Reference Guide.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns

The Amazon Resource Name (ARN) of the registry record.

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.

CreatedAt

The timestamp when the registry record was created.

CreatedBy

The ID of the AWS account that created the registry record.

RecordArn

The Amazon Resource Name (ARN) of the registry record.

RecordId

The unique identifier of the registry record.

RegistryArn

The Amazon Resource Name (ARN) of the registry that contains this record.

Status

The current lifecycle status of the registry record.

UpdatedAt

The timestamp when the registry record was last updated.