aws-cdk-lib.aws_kendra.CfnDataSource.ConnectionConfigurationProperty

ConnectionConfigurationProperty Struct

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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

databaseHoststringdatabase_hoststrdatabaseHostStringDatabaseHoststringDatabaseHost*stringrequired#

The name of the host for the database.

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

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*stringrequired#

The name of the database containing the document data.

databasePortnumberdatabase_portint | floatdatabasePortNumberDatabasePortdoubleDatabasePort*float64required#

The port that the database uses for connections.

secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*stringrequired#

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials.

notes

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.

tableNamestringtable_namestrtableNameStringTableNamestringTableName*stringrequired#

The name of the table that contains the document data.