CfnKnowledgeBaseMixinProps

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

Bases: object

Properties for CfnKnowledgeBasePropsMixin.

Parameters:

description (Optional[str]) – The description of the knowledge base associated with the inline agent.
knowledge_base_configuration (Union[IResolvable, KnowledgeBaseConfigurationProperty, Dict[str, Any], None]) – Contains details about the embeddings configuration of the knowledge base.
name (Optional[str]) – The name of the knowledge base.
role_arn (Optional[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], None]) – Contains details about the storage configuration 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.mixins_preview.aws_bedrock import mixins as bedrock_mixins

cfn_knowledge_base_mixin_props = bedrock_mixins.CfnKnowledgeBaseMixinProps(
    description="description",
    knowledge_base_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty(
        kendra_knowledge_base_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.KendraKnowledgeBaseConfigurationProperty(
            kendra_index_arn="kendraIndexArn"
        ),
        sql_knowledge_base_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.SqlKnowledgeBaseConfigurationProperty(
            redshift_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftConfigurationProperty(
                query_engine_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftQueryEngineConfigurationProperty(
                    provisioned_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftProvisionedConfigurationProperty(
                        auth_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftProvisionedAuthConfigurationProperty(
                            database_user="databaseUser",
                            type="type",
                            username_password_secret_arn="usernamePasswordSecretArn"
                        ),
                        cluster_identifier="clusterIdentifier"
                    ),
                    serverless_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftServerlessConfigurationProperty(
                        auth_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftServerlessAuthConfigurationProperty(
                            type="type",
                            username_password_secret_arn="usernamePasswordSecretArn"
                        ),
                        workgroup_arn="workgroupArn"
                    ),
                    type="type"
                ),
                query_generation_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.QueryGenerationConfigurationProperty(
                    execution_timeout_seconds=123,
                    generation_context=bedrock_mixins.CfnKnowledgeBasePropsMixin.QueryGenerationContextProperty(
                        curated_queries=[bedrock_mixins.CfnKnowledgeBasePropsMixin.CuratedQueryProperty(
                            natural_language="naturalLanguage",
                            sql="sql"
                        )],
                        tables=[bedrock_mixins.CfnKnowledgeBasePropsMixin.QueryGenerationTableProperty(
                            columns=[bedrock_mixins.CfnKnowledgeBasePropsMixin.QueryGenerationColumnProperty(
                                description="description",
                                inclusion="inclusion",
                                name="name"
                            )],
                            description="description",
                            inclusion="inclusion",
                            name="name"
                        )]
                    )
                ),
                storage_configurations=[bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftQueryEngineStorageConfigurationProperty(
                    aws_data_catalog_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty(
                        table_names=["tableNames"]
                    ),
                    redshift_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RedshiftQueryEngineRedshiftStorageConfigurationProperty(
                        database_name="databaseName"
                    ),
                    type="type"
                )]
            ),
            type="type"
        ),
        type="type",
        vector_knowledge_base_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.VectorKnowledgeBaseConfigurationProperty(
            embedding_model_arn="embeddingModelArn",
            embedding_model_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.EmbeddingModelConfigurationProperty(
                bedrock_embedding_model_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.BedrockEmbeddingModelConfigurationProperty(
                    dimensions=123,
                    embedding_data_type="embeddingDataType"
                )
            ),
            supplemental_data_storage_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.SupplementalDataStorageConfigurationProperty(
                supplemental_data_storage_locations=[bedrock_mixins.CfnKnowledgeBasePropsMixin.SupplementalDataStorageLocationProperty(
                    s3_location=bedrock_mixins.CfnKnowledgeBasePropsMixin.S3LocationProperty(
                        uri="uri"
                    ),
                    supplemental_data_storage_location_type="supplementalDataStorageLocationType"
                )]
            )
        )
    ),
    name="name",
    role_arn="roleArn",
    storage_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.StorageConfigurationProperty(
        mongo_db_atlas_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty(
            collection_name="collectionName",
            credentials_secret_arn="credentialsSecretArn",
            database_name="databaseName",
            endpoint="endpoint",
            endpoint_service_name="endpointServiceName",
            field_mapping=bedrock_mixins.CfnKnowledgeBasePropsMixin.MongoDbAtlasFieldMappingProperty(
                metadata_field="metadataField",
                text_field="textField",
                vector_field="vectorField"
            ),
            text_index_name="textIndexName",
            vector_index_name="vectorIndexName"
        ),
        neptune_analytics_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty(
            field_mapping=bedrock_mixins.CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty(
                metadata_field="metadataField",
                text_field="textField"
            ),
            graph_arn="graphArn"
        ),
        opensearch_managed_cluster_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.OpenSearchManagedClusterConfigurationProperty(
            domain_arn="domainArn",
            domain_endpoint="domainEndpoint",
            field_mapping=bedrock_mixins.CfnKnowledgeBasePropsMixin.OpenSearchManagedClusterFieldMappingProperty(
                metadata_field="metadataField",
                text_field="textField",
                vector_field="vectorField"
            ),
            vector_index_name="vectorIndexName"
        ),
        opensearch_serverless_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty(
            collection_arn="collectionArn",
            field_mapping=bedrock_mixins.CfnKnowledgeBasePropsMixin.OpenSearchServerlessFieldMappingProperty(
                metadata_field="metadataField",
                text_field="textField",
                vector_field="vectorField"
            ),
            vector_index_name="vectorIndexName"
        ),
        pinecone_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.PineconeConfigurationProperty(
            connection_string="connectionString",
            credentials_secret_arn="credentialsSecretArn",
            field_mapping=bedrock_mixins.CfnKnowledgeBasePropsMixin.PineconeFieldMappingProperty(
                metadata_field="metadataField",
                text_field="textField"
            ),
            namespace="namespace"
        ),
        rds_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.RdsConfigurationProperty(
            credentials_secret_arn="credentialsSecretArn",
            database_name="databaseName",
            field_mapping=bedrock_mixins.CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty(
                custom_metadata_field="customMetadataField",
                metadata_field="metadataField",
                primary_key_field="primaryKeyField",
                text_field="textField",
                vector_field="vectorField"
            ),
            resource_arn="resourceArn",
            table_name="tableName"
        ),
        s3_vectors_configuration=bedrock_mixins.CfnKnowledgeBasePropsMixin.S3VectorsConfigurationProperty(
            index_arn="indexArn",
            index_name="indexName",
            vector_bucket_arn="vectorBucketArn"
        ),
        type="type"
    ),
    tags={
        "tags_key": "tags"
    }
)