CfnRegistryRecordProps

class aws_cdk.aws_agentregistry.CfnRegistryRecordProps(*, descriptors, name, record_type, description=None, display_name=None, record_version=None, registry_id=None, tags=None)

Bases: object

Properties for defining a CfnRegistryRecord.

Parameters:

• descriptors (Union[IResolvable, DescriptorsProperty, Dict[str, Any]]) – The typed set of descriptors for a registry record. Exactly one descriptor field is populated based on the record type.

• name (str) – The name of the registry record.

• record_type (str) – The type of the registry record.

• description (Optional[str]) – The description of the registry record.

• display_name (Optional[str]) – The human-readable display name of the registry record.

• record_version (Optional[str]) – The version of the registry record.

• registry_id (Optional[str]) – 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).

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the registry record.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_agentregistry as agentregistry

cfn_registry_record_props = agentregistry.CfnRegistryRecordProps(
    descriptors=agentregistry.CfnRegistryRecord.DescriptorsProperty(
        a2_a_agent_card=agentregistry.CfnRegistryRecord.A2aAgentCardDescriptorProperty(
            data="data",
            data_schema_version="dataSchemaVersion",
            source=agentregistry.CfnRegistryRecord.DescriptorSourceProperty(
                from_url=agentregistry.CfnRegistryRecord.DescriptorSourceFromUrlProperty(
                    url="url",

                    # the properties below are optional
                    credential_provider_configurations=[agentregistry.CfnRegistryRecord.RegistryRecordCredentialProviderConfigurationProperty(
                        credential_provider=agentregistry.CfnRegistryRecord.RegistryRecordCredentialProviderUnionProperty(
                            iam_credential_provider=agentregistry.CfnRegistryRecord.RegistryRecordIamCredentialProviderProperty(
                                region="region",
                                role_arn="roleArn",
                                service="service"
                            ),
                            oauth_credential_provider=agentregistry.CfnRegistryRecord.RegistryRecordOAuthCredentialProviderProperty(
                                provider_arn="providerArn",

                                # the properties below are optional
                                custom_parameters={
                                    "custom_parameters_key": "customParameters"
                                },
                                grant_type="grantType",
                                scopes=["scopes"]
                            )
                        ),
                        credential_provider_type="credentialProviderType"
                    )]
                )
            )
        ),
        agent_skills_definition=agentregistry.CfnRegistryRecord.AgentSkillsDefinitionDescriptorProperty(
            additional_data=agentregistry.CfnRegistryRecord.AgentSkillsAdditionalDataProperty(
                skill_md=agentregistry.CfnRegistryRecord.AgentSkillsMdDescriptorProperty(
                    data="data",
                    data_schema_version="dataSchemaVersion",
                    source=agentregistry.CfnRegistryRecord.SkillMdSourceProperty(
                        from_url=agentregistry.CfnRegistryRecord.SkillMdSourceFromUrlProperty(
                            url="url"
                        )
                    )
                )
            ),
            data="data",
            data_schema_version="dataSchemaVersion"
        ),
        agui=agentregistry.CfnRegistryRecord.AgUiDescriptorProperty(
            source=agentregistry.CfnRegistryRecord.SourceOnlyDescriptorSourceProperty(
                from_url=agentregistry.CfnRegistryRecord.SourceOnlyDescriptorSourceFromUrlProperty(
                    url="url"
                )
            )
        ),
        custom=agentregistry.CfnRegistryRecord.CustomDescriptorProperty(
            data="data"
        ),
        http=agentregistry.CfnRegistryRecord.HttpDescriptorProperty(
            source=agentregistry.CfnRegistryRecord.SourceOnlyDescriptorSourceProperty(
                from_url=agentregistry.CfnRegistryRecord.SourceOnlyDescriptorSourceFromUrlProperty(
                    url="url"
                )
            )
        ),
        mcp_server=agentregistry.CfnRegistryRecord.McpServerDescriptorProperty(
            additional_data=agentregistry.CfnRegistryRecord.McpServerAdditionalDataProperty(
                tools=agentregistry.CfnRegistryRecord.McpToolsDescriptorProperty(
                    data="data",
                    data_schema_version="dataSchemaVersion"
                )
            ),
            data="data",
            data_schema_version="dataSchemaVersion",
            source=agentregistry.CfnRegistryRecord.DescriptorSourceProperty(
                from_url=agentregistry.CfnRegistryRecord.DescriptorSourceFromUrlProperty(
                    url="url",

                    # the properties below are optional
                    credential_provider_configurations=[agentregistry.CfnRegistryRecord.RegistryRecordCredentialProviderConfigurationProperty(
                        credential_provider=agentregistry.CfnRegistryRecord.RegistryRecordCredentialProviderUnionProperty(
                            iam_credential_provider=agentregistry.CfnRegistryRecord.RegistryRecordIamCredentialProviderProperty(
                                region="region",
                                role_arn="roleArn",
                                service="service"
                            ),
                            oauth_credential_provider=agentregistry.CfnRegistryRecord.RegistryRecordOAuthCredentialProviderProperty(
                                provider_arn="providerArn",

                                # the properties below are optional
                                custom_parameters={
                                    "custom_parameters_key": "customParameters"
                                },
                                grant_type="grantType",
                                scopes=["scopes"]
                            )
                        ),
                        credential_provider_type="credentialProviderType"
                    )]
                )
            )
        )
    ),
    name="name",
    record_type="recordType",

    # the properties below are optional
    description="description",
    display_name="displayName",
    record_version="recordVersion",
    registry_id="registryId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the registry record.

See:

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

descriptors

The typed set of descriptors for a registry record.

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

See:

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

display_name

The human-readable display name of the registry record.

See:

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

name

The name of the registry record.

See:

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

record_type

The type of the registry record.

See:

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

record_version

The version of the registry record.

See:

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

registry_id

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:

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

tags

Tags to assign to the registry record.

See:

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