interface CfnRegistryRecordProps

Language	Type name
.NET	Amazon.CDK.AWS.AgentRegistry.CfnRegistryRecordProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsagentregistry#CfnRegistryRecordProps
Java	software.amazon.awscdk.services.agentregistry.CfnRegistryRecordProps
Python	aws_cdk.aws_agentregistry.CfnRegistryRecordProps
TypeScript	aws-cdk-lib » aws_agentregistry » CfnRegistryRecordProps

Properties for defining a CfnRegistryRecord.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html

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 cfnRegistryRecordProps: agentregistry.CfnRegistryRecordProps = {
  descriptors: {
    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',
    },
    custom: {
      data: 'data',
    },
    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',
          }],
        },
      },
    },
  },
  name: 'name',
  recordType: 'recordType',

  // the properties below are optional
  description: 'description',
  displayName: 'displayName',
  recordVersion: 'recordVersion',
  registryId: 'registryId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
descriptors	IResolvable | DescriptorsProperty	The typed set of descriptors for a registry record.
name	string	The name of the registry record.
recordType	string	The type of the registry record.
description?	string	The description of the registry record.
displayName?	string	The human-readable display name of the registry record.
recordVersion?	string	The version of the registry record.
registryId?	string	The identifier of the registry in which to create the record.
tags?	CfnTag[]	Tags to assign to the registry record.

---

descriptors

Type: IResolvable | DescriptorsProperty

The typed set of descriptors for a registry record.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-descriptors

---

name

Type: string

The name of the registry record.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-name

---

recordType

Type: string

The type of the registry record.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-recordtype

---

description?

Type: string (optional)

The description of the registry record.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-description

---

displayName?

Type: string (optional)

The human-readable display name of the registry record.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-displayname

---

recordVersion?

Type: string (optional)

The version of the registry record.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-recordversion

---

registryId?

Type: string (optional)

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). Use the ARN form to reference a registry shared from another account via AWS Resource Access Manager (RAM).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-registryid

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the registry record.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-agentregistry-registryrecord.html#cfn-agentregistry-registryrecord-tags