interface CfnKnowledgeBaseMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnKnowledgeBaseMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnKnowledgeBaseMixinProps
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnKnowledgeBaseMixinProps
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBaseMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnKnowledgeBaseMixinProps

Properties for CfnKnowledgeBasePropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const cfnKnowledgeBaseMixinProps: bedrock_mixins.CfnKnowledgeBaseMixinProps = {
  description: 'description',
  knowledgeBaseConfiguration: {
    kendraKnowledgeBaseConfiguration: {
      kendraIndexArn: 'kendraIndexArn',
    },
    sqlKnowledgeBaseConfiguration: {
      redshiftConfiguration: {
        queryEngineConfiguration: {
          provisionedConfiguration: {
            authConfiguration: {
              databaseUser: 'databaseUser',
              type: 'type',
              usernamePasswordSecretArn: 'usernamePasswordSecretArn',
            },
            clusterIdentifier: 'clusterIdentifier',
          },
          serverlessConfiguration: {
            authConfiguration: {
              type: 'type',
              usernamePasswordSecretArn: 'usernamePasswordSecretArn',
            },
            workgroupArn: 'workgroupArn',
          },
          type: 'type',
        },
        queryGenerationConfiguration: {
          executionTimeoutSeconds: 123,
          generationContext: {
            curatedQueries: [{
              naturalLanguage: 'naturalLanguage',
              sql: 'sql',
            }],
            tables: [{
              columns: [{
                description: 'description',
                inclusion: 'inclusion',
                name: 'name',
              }],
              description: 'description',
              inclusion: 'inclusion',
              name: 'name',
            }],
          },
        },
        storageConfigurations: [{
          awsDataCatalogConfiguration: {
            tableNames: ['tableNames'],
          },
          redshiftConfiguration: {
            databaseName: 'databaseName',
          },
          type: 'type',
        }],
      },
      type: 'type',
    },
    type: 'type',
    vectorKnowledgeBaseConfiguration: {
      embeddingModelArn: 'embeddingModelArn',
      embeddingModelConfiguration: {
        bedrockEmbeddingModelConfiguration: {
          audio: [{
            segmentationConfiguration: {
              fixedLengthDuration: 123,
            },
          }],
          dimensions: 123,
          embeddingDataType: 'embeddingDataType',
          video: [{
            segmentationConfiguration: {
              fixedLengthDuration: 123,
            },
          }],
        },
      },
      supplementalDataStorageConfiguration: {
        supplementalDataStorageLocations: [{
          s3Location: {
            uri: 'uri',
          },
          supplementalDataStorageLocationType: 'supplementalDataStorageLocationType',
        }],
      },
    },
  },
  name: 'name',
  roleArn: 'roleArn',
  storageConfiguration: {
    mongoDbAtlasConfiguration: {
      collectionName: 'collectionName',
      credentialsSecretArn: 'credentialsSecretArn',
      databaseName: 'databaseName',
      endpoint: 'endpoint',
      endpointServiceName: 'endpointServiceName',
      fieldMapping: {
        metadataField: 'metadataField',
        textField: 'textField',
        vectorField: 'vectorField',
      },
      textIndexName: 'textIndexName',
      vectorIndexName: 'vectorIndexName',
    },
    neptuneAnalyticsConfiguration: {
      fieldMapping: {
        metadataField: 'metadataField',
        textField: 'textField',
      },
      graphArn: 'graphArn',
    },
    opensearchManagedClusterConfiguration: {
      domainArn: 'domainArn',
      domainEndpoint: 'domainEndpoint',
      fieldMapping: {
        metadataField: 'metadataField',
        textField: 'textField',
        vectorField: 'vectorField',
      },
      vectorIndexName: 'vectorIndexName',
    },
    opensearchServerlessConfiguration: {
      collectionArn: 'collectionArn',
      fieldMapping: {
        metadataField: 'metadataField',
        textField: 'textField',
        vectorField: 'vectorField',
      },
      vectorIndexName: 'vectorIndexName',
    },
    pineconeConfiguration: {
      connectionString: 'connectionString',
      credentialsSecretArn: 'credentialsSecretArn',
      fieldMapping: {
        metadataField: 'metadataField',
        textField: 'textField',
      },
      namespace: 'namespace',
    },
    rdsConfiguration: {
      credentialsSecretArn: 'credentialsSecretArn',
      databaseName: 'databaseName',
      fieldMapping: {
        customMetadataField: 'customMetadataField',
        metadataField: 'metadataField',
        primaryKeyField: 'primaryKeyField',
        textField: 'textField',
        vectorField: 'vectorField',
      },
      resourceArn: 'resourceArn',
      tableName: 'tableName',
    },
    s3VectorsConfiguration: {
      indexArn: 'indexArn',
      indexName: 'indexName',
      vectorBucketArn: 'vectorBucketArn',
    },
    type: 'type',
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
description?	string	The description of the knowledge base associated with the inline agent.
knowledgeBaseConfiguration?	IResolvable | KnowledgeBaseConfigurationProperty	Contains details about the embeddings configuration of the knowledge base.
name?	string	The name of the knowledge base.
roleArn?	string	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
storageConfiguration?	IResolvable | StorageConfigurationProperty	Contains details about the storage configuration of the knowledge base.
tags?	{ [string]: string }	Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

---

description?

Type: string (optional)

The description of the knowledge base associated with the inline agent.

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

---

knowledgeBaseConfiguration?

Type: IResolvable | KnowledgeBaseConfigurationProperty (optional)

Contains details about the embeddings configuration of the knowledge base.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration

---

name?

Type: string (optional)

The name of the knowledge base.

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

---

roleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-rolearn

---

storageConfiguration?

Type: IResolvable | StorageConfigurationProperty (optional)

Contains details about the storage configuration of the knowledge base.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-storageconfiguration

---

tags?

Type: { [string]: string } (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-tags