CfnKnowledgeBaseProps

class aws_cdk.aws_bedrock.CfnKnowledgeBaseProps(*, knowledge_base_configuration, name, role_arn, storage_configuration, description=None, tags=None)

Bases: object

Properties for defining a CfnKnowledgeBase.

Parameters:

knowledge_base_configuration (Union[IResolvable, KnowledgeBaseConfigurationProperty, Dict[str, Any]]) – Contains details about the embeddings configuration of the knowledge base.
name (str) – The name of the knowledge base.
role_arn (str) – The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
storage_configuration (Union[IResolvable, StorageConfigurationProperty, Dict[str, Any]]) – Contains details about the storage configuration of the knowledge base.
description (Optional[str]) – The description of the knowledge base.
tags (Optional[Mapping[str, str]]) – Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. - Tag naming limits and requirements - Tagging best practices

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html

ExampleMetadata:

fixture=_generated

Example:

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

cfn_knowledge_base_props = bedrock.CfnKnowledgeBaseProps(
    knowledge_base_configuration=bedrock.CfnKnowledgeBase.KnowledgeBaseConfigurationProperty(
        type="type",
        vector_knowledge_base_configuration=bedrock.CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty(
            embedding_model_arn="embeddingModelArn"
        )
    ),
    name="name",
    role_arn="roleArn",
    storage_configuration=bedrock.CfnKnowledgeBase.StorageConfigurationProperty(
        type="type",

        # the properties below are optional
        opensearch_serverless_configuration=bedrock.CfnKnowledgeBase.OpenSearchServerlessConfigurationProperty(
            collection_arn="collectionArn",
            field_mapping=bedrock.CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty(
                metadata_field="metadataField",
                text_field="textField",
                vector_field="vectorField"
            ),
            vector_index_name="vectorIndexName"
        ),
        pinecone_configuration=bedrock.CfnKnowledgeBase.PineconeConfigurationProperty(
            connection_string="connectionString",
            credentials_secret_arn="credentialsSecretArn",
            field_mapping=bedrock.CfnKnowledgeBase.PineconeFieldMappingProperty(
                metadata_field="metadataField",
                text_field="textField"
            ),

            # the properties below are optional
            namespace="namespace"
        ),
        rds_configuration=bedrock.CfnKnowledgeBase.RdsConfigurationProperty(
            credentials_secret_arn="credentialsSecretArn",
            database_name="databaseName",
            field_mapping=bedrock.CfnKnowledgeBase.RdsFieldMappingProperty(
                metadata_field="metadataField",
                primary_key_field="primaryKeyField",
                text_field="textField",
                vector_field="vectorField"
            ),
            resource_arn="resourceArn",
            table_name="tableName"
        )
    ),

    # the properties below are optional
    description="description",
    tags={
        "tags_key": "tags"
    }
)