Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Interface CfnKnowledgeBasePropsMixin.RdsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBasePropsMixin.RdsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBasePropsMixin

@Stability(Stable)
public static interface CfnKnowledgeBasePropsMixin.RdsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 RdsConfigurationProperty rdsConfigurationProperty = RdsConfigurationProperty.builder()
         .credentialsSecretArn("credentialsSecretArn")
         .databaseName("databaseName")
         .fieldMapping(RdsFieldMappingProperty.builder()
                 .customMetadataField("customMetadataField")
                 .metadataField("metadataField")
                 .primaryKeyField("primaryKeyField")
                 .textField("textField")
                 .vectorField("vectorField")
                 .build())
         .resourceArn("resourceArn")
         .tableName("tableName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBasePropsMixin.RdsConfigurationProperty.Builder	A builder for CfnKnowledgeBasePropsMixin.RdsConfigurationProperty
static final class	CfnKnowledgeBasePropsMixin.RdsConfigurationProperty.Jsii$Proxy	An implementation for CfnKnowledgeBasePropsMixin.RdsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBasePropsMixin.RdsConfigurationProperty.Builder	builder()
default String	getCredentialsSecretArn()	The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
default String	getDatabaseName()	The name of your Amazon RDS database.
default Object	getFieldMapping()	Contains the names of the fields to which to map information about the vector store.
default String	getResourceArn()	The Amazon Resource Name (ARN) of the vector store.
default String	getTableName()	The name of the table in the database.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCredentialsSecretArn

@Stability(Stable)
@Nullable
default String getCredentialsSecretArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-credentialssecretarn

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

The name of your Amazon RDS database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-databasename

getFieldMapping

@Stability(Stable)
@Nullable
default Object getFieldMapping()

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

Returns union: either IResolvable or CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-fieldmapping

getResourceArn

@Stability(Stable)
@Nullable
default String getResourceArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-resourcearn

getTableName

@Stability(Stable)
@Nullable
default String getTableName()

The name of the table in the database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-rdsconfiguration.html#cfn-bedrock-knowledgebase-rdsconfiguration-tablename

builder

@Stability(Stable)
static CfnKnowledgeBasePropsMixin.RdsConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBasePropsMixin.RdsConfigurationProperty.Builder of CfnKnowledgeBasePropsMixin.RdsConfigurationProperty