aws-cdk-lib.aws_bedrock.CfnKnowledgeBase.RdsConfigurationProperty

RdsConfigurationProperty Struct

Contains details about the storage configuration of the knowledge base in Amazon RDS.

For more information, see Create a vector index in Amazon RDS .

Source

Generated code

Type last changed

v2.140.0 · 2 May 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const rdsConfigurationProperty: bedrock.CfnKnowledgeBase.RdsConfigurationProperty = {
  credentialsSecretArn: 'credentialsSecretArn',
  databaseName: 'databaseName',
  fieldMapping: {
    metadataField: 'metadataField',
    primaryKeyField: 'primaryKeyField',
    textField: 'textField',
    vectorField: 'vectorField',

    // the properties below are optional
    customMetadataField: 'customMetadataField',
  },
  resourceArn: 'resourceArn',
  tableName: 'tableName',
};

Properties

credentialsSecretArnstringcredentials_secret_arnstrcredentialsSecretArnStringCredentialsSecretArnstringCredentialsSecretArn*stringrequired#

The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*stringrequired#

The name of your Amazon RDS database.

fieldMappingIResolvable | CfnKnowledgeBase.RdsFieldMappingPropertyfield_mappingtyping.Union[IResolvable, RdsFieldMappingProperty]fieldMappingIResolvableFieldMappingIResolvableFieldMappinginterface{}required#

Contains the names of the fields to which to map information about the vector store.

resourceArnstringresource_arnstrresourceArnStringResourceArnstringResourceArn*stringrequired#

The Amazon Resource Name (ARN) of the vector store.

tableNamestringtable_namestrtableNameStringTableNamestringTableName*stringrequired#

The name of the table in the database.