aws-cdk-lib.aws_kendra.CfnDataSource.ConnectionConfigurationProperty

interface ConnectionConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.ConnectionConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_ConnectionConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.ConnectionConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.ConnectionConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnDataSource » ConnectionConfigurationProperty

Provides the configuration information that's required to connect to a database.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const connectionConfigurationProperty: kendra.CfnDataSource.ConnectionConfigurationProperty = {
  databaseHost: 'databaseHost',
  databaseName: 'databaseName',
  databasePort: 123,
  secretArn: 'secretArn',
  tableName: 'tableName',
};

Properties

NameTypeDescription
databaseHoststringThe name of the host for the database.
databaseNamestringThe name of the database containing the document data.
databasePortnumberThe port that the database uses for connections.
secretArnstringThe Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager .
tableNamestringThe name of the table that contains the document data.

databaseHost

Type: string

The name of the host for the database.

Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.


databaseName

Type: string

The name of the database containing the document data.


databasePort

Type: number

The port that the database uses for connections.


secretArn

Type: string

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager .

The credentials should be a user/password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.


tableName

Type: string

The name of the table that contains the document data.