Skip to content
v2.275.0

DescriptorsProperty Struct ​

The typed set of descriptors for a registry record.

Exactly one descriptor field is populated based on the record type.

Example ​

ts
// 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 descriptorsProperty: agentregistry.CfnRegistryRecord.DescriptorsProperty = {
  a2AAgentCard: {
    data: 'data',
    dataSchemaVersion: 'dataSchemaVersion',
    source: {
      fromUrl: {
        url: 'url',

        // the properties below are optional
        credentialProviderConfigurations: [{
          credentialProvider: {
            iamCredentialProvider: {
              region: 'region',
              roleArn: 'roleArn',
              service: 'service',
            },
            oauthCredentialProvider: {
              providerArn: 'providerArn',

              // the properties below are optional
              customParameters: {
                customParametersKey: 'customParameters',
              },
              grantType: 'grantType',
              scopes: ['scopes'],
            },
          },
          credentialProviderType: 'credentialProviderType',
        }],
      },
    },
  },
  agentSkillsDefinition: {
    additionalData: {
      skillMd: {
        data: 'data',
        dataSchemaVersion: 'dataSchemaVersion',
        source: {
          fromUrl: {
            url: 'url',
          },
        },
      },
    },
    data: 'data',
    dataSchemaVersion: 'dataSchemaVersion',
  },
  agui: {
    source: {
      fromUrl: {
        url: 'url',
      },
    },
  },
  custom: {
    data: 'data',
  },
  http: {
    source: {
      fromUrl: {
        url: 'url',
      },
    },
  },
  mcpServer: {
    additionalData: {
      tools: {
        data: 'data',
        dataSchemaVersion: 'dataSchemaVersion',
      },
    },
    data: 'data',
    dataSchemaVersion: 'dataSchemaVersion',
    source: {
      fromUrl: {
        url: 'url',

        // the properties below are optional
        credentialProviderConfigurations: [{
          credentialProvider: {
            iamCredentialProvider: {
              region: 'region',
              roleArn: 'roleArn',
              service: 'service',
            },
            oauthCredentialProvider: {
              providerArn: 'providerArn',

              // the properties below are optional
              customParameters: {
                customParametersKey: 'customParameters',
              },
              grantType: 'grantType',
              scopes: ['scopes'],
            },
          },
          credentialProviderType: 'credentialProviderType',
        }],
      },
    },
  },
};

Properties ​

a2AAgentCardoptionalIResolvable | CfnRegistryRecord.A2aAgentCardDescriptorPropertya2_a_agent_cardoptionaltyping.Union[IResolvable, A2aAgentCardDescriptorProperty]a2AAgentCardoptionalIResolvableA2AAgentCardoptionalIResolvableA2AAgentCardoptionalinterface{}#
The A2A agent card descriptor, populated when the record type is AGENT.
agentSkillsDefinitionoptionalIResolvable | CfnRegistryRecord.AgentSkillsDefinitionDescriptorPropertyagent_skills_definitionoptionaltyping.Union[IResolvable, AgentSkillsDefinitionDescriptorProperty]agentSkillsDefinitionoptionalIResolvableAgentSkillsDefinitionoptionalIResolvableAgentSkillsDefinitionoptionalinterface{}#
The agent skills definition descriptor, populated when the record type is SKILL.
aguioptionalIResolvable | CfnRegistryRecord.AgUiDescriptorPropertyaguioptionaltyping.Union[IResolvable, AgUiDescriptorProperty]aguioptionalIResolvableAguioptionalIResolvableAguioptionalinterface{}#
The AG-UI (Agent-User Interaction) descriptor, populated for records detected from an AG-UI protocol source.

This descriptor is source-only: its content is synchronized from the configured source URL rather than supplied inline.

customoptionalIResolvable | CfnRegistryRecord.CustomDescriptorPropertycustomoptionaltyping.Union[IResolvable, CustomDescriptorProperty]customoptionalIResolvableCustomoptionalIResolvableCustomoptionalinterface{}#
The custom descriptor, populated when the record type is CUSTOM.
httpoptionalIResolvable | CfnRegistryRecord.HttpDescriptorPropertyhttpoptionaltyping.Union[IResolvable, HttpDescriptorProperty]httpoptionalIResolvableHttpoptionalIResolvableHttpoptionalinterface{}#
The HTTP descriptor, populated for records detected from an HTTP protocol source.

This descriptor is source-only: its content is synchronized from the configured source URL rather than supplied inline.

mcpServeroptionalIResolvable | CfnRegistryRecord.McpServerDescriptorPropertymcp_serveroptionaltyping.Union[IResolvable, McpServerDescriptorProperty]mcpServeroptionalIResolvableMcpServeroptionalIResolvableMcpServeroptionalinterface{}#
The MCP server descriptor, populated when the record type is MCP.