This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::AgentRegistry::Registry
The AWS::AgentRegistry::Registry resource specifies a registry. A registry is a managed catalog for publishing and discovering resources such as Model Context Protocol (MCP) servers, agents, and agent skills. It organizes registry records and defines how consumers discover them, how they are authorized, and how submitted records are approved.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::AgentRegistry::Registry", "Properties" : { "ApprovalConfiguration" :ApprovalConfiguration, "AuthorizerType" :String, "AutoDetectionEnabled" :Boolean, "AutoDetectionScope" :String, "CustomMetadataSchemaConfiguration" :CustomMetadataSchemaConfiguration, "Description" :String, "DiscoveryConfiguration" :DiscoveryConfiguration, "EncryptionConfiguration" :EncryptionConfiguration, "Name" :String, "Tags" :[ Tag, ... ]} }
YAML
Type: AWS::AgentRegistry::Registry Properties: ApprovalConfiguration:ApprovalConfigurationAuthorizerType:StringAutoDetectionEnabled:BooleanAutoDetectionScope:StringCustomMetadataSchemaConfiguration:CustomMetadataSchemaConfigurationDescription:StringDiscoveryConfiguration:DiscoveryConfigurationEncryptionConfiguration:EncryptionConfigurationName:StringTags:- Tag
Properties
ApprovalConfiguration-
The configuration for the registry's record approval workflow. It controls whether submitted records require manual review before becoming discoverable, or are automatically approved.
Required: No
Type: ApprovalConfiguration
Update requires: No interruption
-
The type of authorizer that controls how consumers access the registry's search and MCP invoke operations.
Required: No
Type: String
Allowed values:
CUSTOM_JWT | AWS_IAMUpdate requires: Replacement
AutoDetectionEnabled-
Specifies whether auto-detection is requested for the registry. You must specify this property together with
AutoDetectionScope.Setting this property to
trueis necessary but not sufficient for auto-detection to become active. The preconditions of the configured scope must also be met. To check whether auto-detection is active, use theAutoDetectionStatusreturn value.To turn off auto-detection, explicitly set this property to
false. If you removeAutoDetectionEnabledandAutoDetectionScopefrom the template, the existing auto-detection settings don't change.You can't delete a registry while auto-detection is enabled. Before you delete the registry, set this property to
falseand update the stack.Required: No
Type: Boolean
Update requires: No interruption
AutoDetectionScope-
The source from which the registry detects resources. The only supported value is
ORGANIZATION, which detects resources from all member accounts of an Amazon organization. You must specify this property together withAutoDetectionEnabled.Required: No
Type: String
Allowed values:
ORGANIZATIONUpdate requires: No interruption
CustomMetadataSchemaConfiguration-
The configuration that defines a typed custom metadata schema for the registry. Registry records use this schema for their custom metadata. You can specify a default schema, schema overrides for specific record types, or both. Both are optional.
Schema evolution is additive only. You can add fields and enum values. You can't remove fields, change field types, or remove enum values.
If you remove this property from the template during a stack update, the existing schema isn't cleared. The service keeps the current schema.
Required: No
Type: CustomMetadataSchemaConfiguration
Update requires: No interruption
Description-
The description of the registry.
Required: No
Type: String
Minimum:
1Maximum:
4096Update requires: No interruption
DiscoveryConfiguration-
The discovery configuration for the registry. It controls how consumers are authorized to search the registry and invoke its MCP endpoint.
Required: No
Type: DiscoveryConfiguration
Update requires: No interruption
EncryptionConfiguration-
The server-side encryption configuration for the registry. It specifies a customer managed Amazon Key Management Service (Amazon KMS) key that encrypts the registry's content. If you omit this property, the registry's content is encrypted with an Amazon owned key.
You can't change the encryption configuration after you create the registry. If you specify a different KMS key, add this property to an existing registry, or remove it, CloudFormation replaces the registry. CloudFormation creates a new registry with a new Amazon Resource Name (ARN). Then it deletes the original registry, including the registry records that it contains.
CloudFormation doesn't re-create registry records that the stack doesn't manage. If any of these records remain in the original registry, CloudFormation can't delete the original registry, and it remains in your account.
Required: No
Type: EncryptionConfiguration
Update requires: Replacement
Name-
The name of the registry.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_\-\.\/]*$Minimum:
1Maximum:
64Update requires: No interruption
-
A list of key-value pairs that contain metadata for the registry. For more information, see Tagging Amazon resources in the Amazon General Reference Guide.
Required: No
Type: Array of Tag
Maximum:
50Update 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.
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.
AutoDetectionStatus-
The current auto-detection status of the registry.
ACTIVEindicates that the registry is actively being populated with detected resources.INACTIVEindicates that the preconditions required at the configured scope aren't currently met. CreatedAt-
The timestamp when the registry was created.
RegistryArn-
The Amazon Resource Name (ARN) of the registry.
RegistryId-
The unique identifier of the registry.
Status-
The current status of the registry.
UpdatedAt-
The timestamp when the registry was last updated.