CfnRegistryProps Struct
Properties for defining a CfnRegistry.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_agentregistry as agentregistry } from 'aws-cdk-lib';
const cfnRegistryProps: agentregistry.CfnRegistryProps = {
name: 'name',
// the properties below are optional
approvalConfiguration: {
autoApprovalRules: ['autoApprovalRules'],
},
authorizerType: 'authorizerType',
autoDetectionEnabled: false,
autoDetectionScope: 'autoDetectionScope',
customMetadataSchemaConfiguration: {
defaultSchema: 'defaultSchema',
recordTypeSchemaOverrides: [{
recordType: 'recordType',
schema: 'schema',
}],
},
description: 'description',
discoveryConfiguration: {
authorizerConfiguration: {
customJwtAuthorizer: {
discoveryUrl: 'discoveryUrl',
// the properties below are optional
allowedAudience: ['allowedAudience'],
allowedClients: ['allowedClients'],
allowedScopes: ['allowedScopes'],
customClaims: [{
authorizingClaimMatchValue: {
claimMatchOperator: 'claimMatchOperator',
claimMatchValue: {
matchValueString: 'matchValueString',
matchValueStringList: ['matchValueStringList'],
},
},
inboundTokenClaimName: 'inboundTokenClaimName',
inboundTokenClaimValueType: 'inboundTokenClaimValueType',
}],
},
},
},
encryptionConfiguration: {
kmsKeyArn: 'kmsKeyArn',
},
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
approvalConfigurationoptionalIResolvable | CfnRegistry.ApprovalConfigurationPropertyapproval_configurationoptionaltyping.Union[IResolvable, ApprovalConfigurationProperty]approvalConfigurationoptionalIResolvableApprovalConfigurationoptionalIResolvableApprovalConfigurationoptionalinterface{}#authorizerTypeoptionalstringauthorizer_typeoptionalstrauthorizerTypeoptionalStringAuthorizerTypeoptionalstringAuthorizerTypeoptional*string#autoDetectionEnabledoptionalboolean | IResolvableauto_detection_enabledoptionaltyping.Union[bool, IResolvable]autoDetectionEnabledoptionalBooleanAutoDetectionEnabledoptionalboolAutoDetectionEnabledoptionalinterface{}#notes
Must be specified together with AutoDetectionScope. Setting this to true is necessary but not sufficient for auto-detection to become active; the preconditions of the configured scope must also be met. To turn auto-detection off, explicitly set this to false - removing AutoDetectionEnabled and AutoDetectionScope from the template is a no-op and leaves the existing auto-detection settings unchanged. A registry cannot be deleted while auto-detection is enabled: set this to false and update the stack before deleting the registry.
autoDetectionScopeoptionalstringauto_detection_scopeoptionalstrautoDetectionScopeoptionalStringAutoDetectionScopeoptionalstringAutoDetectionScopeoptional*string#ORGANIZATION sources resources from all member accounts of an AWS Organization.
customMetadataSchemaConfigurationoptionalIResolvable | CfnRegistry.CustomMetadataSchemaConfigurationPropertycustom_metadata_schema_configurationoptionaltyping.Union[IResolvable, CustomMetadataSchemaConfigurationProperty]customMetadataSchemaConfigurationoptionalIResolvableCustomMetadataSchemaConfigurationoptionalIResolvableCustomMetadataSchemaConfigurationoptionalinterface{}#A default schema and per-record-type schema overrides are both optional. Schema evolution is additive only: you can add fields and enum values, but you cannot remove fields, change types, or remove enum values.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#discoveryConfigurationoptionalIResolvable | CfnRegistry.DiscoveryConfigurationPropertydiscovery_configurationoptionaltyping.Union[IResolvable, DiscoveryConfigurationProperty]discoveryConfigurationoptionalIResolvableDiscoveryConfigurationoptionalIResolvableDiscoveryConfigurationoptionalinterface{}#Controls how consumers are authorized to search the registry and invoke its MCP endpoint.
encryptionConfigurationoptionalIResolvable | CfnRegistry.EncryptionConfigurationPropertyencryption_configurationoptionaltyping.Union[IResolvable, EncryptionConfigurationProperty]encryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalinterface{}#notes
Specifies a customer managed key used to encrypt the registry's content. When omitted, the registry's content is encrypted with an AWS owned key. You cannot change the encryption configuration after registry creation. Specifying a different KMS key, adding this property to an existing registry, or removing it replaces the registry: CloudFormation creates a new registry with a new Amazon Resource Name (ARN) and then deletes the original, including all registry records it contains. Registry records that are not managed by the stack are not re-created in the new registry, and if any remain in the original registry its deletion fails and it is left behind.