Package software.amazon.awscdk.services.agentregistry

Interface CfnRegistryRecordProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRegistryRecordProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:01.961Z")
@Stability(Stable)
public interface CfnRegistryRecordProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRegistryRecord.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.agentregistry.*;
 CfnRegistryRecordProps cfnRegistryRecordProps = CfnRegistryRecordProps.builder()
         .descriptors(DescriptorsProperty.builder()
                 .a2AAgentCard(A2aAgentCardDescriptorProperty.builder()
                         .data("data")
                         .dataSchemaVersion("dataSchemaVersion")
                         .source(DescriptorSourceProperty.builder()
                                 .fromUrl(DescriptorSourceFromUrlProperty.builder()
                                         .url("url")
                                         // the properties below are optional
                                         .credentialProviderConfigurations(List.of(RegistryRecordCredentialProviderConfigurationProperty.builder()
                                                 .credentialProvider(RegistryRecordCredentialProviderUnionProperty.builder()
                                                         .iamCredentialProvider(RegistryRecordIamCredentialProviderProperty.builder()
                                                                 .region("region")
                                                                 .roleArn("roleArn")
                                                                 .service("service")
                                                                 .build())
                                                         .oauthCredentialProvider(RegistryRecordOAuthCredentialProviderProperty.builder()
                                                                 .providerArn("providerArn")
                                                                 // the properties below are optional
                                                                 .customParameters(Map.of(
                                                                         "customParametersKey", "customParameters"))
                                                                 .grantType("grantType")
                                                                 .scopes(List.of("scopes"))
                                                                 .build())
                                                         .build())
                                                 .credentialProviderType("credentialProviderType")
                                                 .build()))
                                         .build())
                                 .build())
                         .build())
                 .agentSkillsDefinition(AgentSkillsDefinitionDescriptorProperty.builder()
                         .additionalData(AgentSkillsAdditionalDataProperty.builder()
                                 .skillMd(AgentSkillsMdDescriptorProperty.builder()
                                         .data("data")
                                         .dataSchemaVersion("dataSchemaVersion")
                                         .source(SkillMdSourceProperty.builder()
                                                 .fromUrl(SkillMdSourceFromUrlProperty.builder()
                                                         .url("url")
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .data("data")
                         .dataSchemaVersion("dataSchemaVersion")
                         .build())
                 .custom(CustomDescriptorProperty.builder()
                         .data("data")
                         .build())
                 .mcpServer(McpServerDescriptorProperty.builder()
                         .additionalData(McpServerAdditionalDataProperty.builder()
                                 .tools(McpToolsDescriptorProperty.builder()
                                         .data("data")
                                         .dataSchemaVersion("dataSchemaVersion")
                                         .build())
                                 .build())
                         .data("data")
                         .dataSchemaVersion("dataSchemaVersion")
                         .source(DescriptorSourceProperty.builder()
                                 .fromUrl(DescriptorSourceFromUrlProperty.builder()
                                         .url("url")
                                         // the properties below are optional
                                         .credentialProviderConfigurations(List.of(RegistryRecordCredentialProviderConfigurationProperty.builder()
                                                 .credentialProvider(RegistryRecordCredentialProviderUnionProperty.builder()
                                                         .iamCredentialProvider(RegistryRecordIamCredentialProviderProperty.builder()
                                                                 .region("region")
                                                                 .roleArn("roleArn")
                                                                 .service("service")
                                                                 .build())
                                                         .oauthCredentialProvider(RegistryRecordOAuthCredentialProviderProperty.builder()
                                                                 .providerArn("providerArn")
                                                                 // the properties below are optional
                                                                 .customParameters(Map.of(
                                                                         "customParametersKey", "customParameters"))
                                                                 .grantType("grantType")
                                                                 .scopes(List.of("scopes"))
                                                                 .build())
                                                         .build())
                                                 .credentialProviderType("credentialProviderType")
                                                 .build()))
                                         .build())
                                 .build())
                         .build())
                 .build())
         .name("name")
         .recordType("recordType")
         .registryId("registryId")
         // the properties below are optional
         .description("description")
         .displayName("displayName")
         .recordVersion("recordVersion")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRegistryRecordProps.Builder	A builder for CfnRegistryRecordProps
static final class	CfnRegistryRecordProps.Jsii$Proxy	An implementation for CfnRegistryRecordProps

Method Summary

Modifier and Type	Method	Description
static CfnRegistryRecordProps.Builder	builder()
default String	getDescription()	The description of the registry record.
Object	getDescriptors()	The typed set of descriptors for a registry record.
default String	getDisplayName()	The human-readable display name of the registry record.
String	getName()	The name of the registry record.
String	getRecordType()	The type of the registry record.
default String	getRecordVersion()	The version of the registry record.
String	getRegistryId()	The identifier of the registry containing the record.
default List<CfnTag>	getTags()	Tags to assign to the registry record.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescriptors

@Stability(Stable)
@NotNull
Object getDescriptors()

The typed set of descriptors for a registry record.

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

Returns union: either IResolvable or CfnRegistryRecord.DescriptorsProperty

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

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

getRecordType

@Stability(Stable)
@NotNull
String getRecordType()

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

getRegistryId

@Stability(Stable)
@NotNull
String getRegistryId()

The identifier of the registry containing the record.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

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

getRecordVersion

@Stability(Stable)
@Nullable
default String getRecordVersion()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnRegistryRecordProps.Builder builder()

Returns:

a CfnRegistryRecordProps.Builder of CfnRegistryRecordProps