interface ConnectionConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Kendra.CfnDataSource.ConnectionConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_ConnectionConfigurationProperty
Java	software.amazon.awscdk.services.kendra.CfnDataSource.ConnectionConfigurationProperty
Python	aws_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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html

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

Name	Type	Description
databaseHost	string	The name of the host for the database.
databaseName	string	The name of the database containing the document data.
databasePort	number	The port that the database uses for connections.
secretArn	string	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials.
tableName	string	The 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasehost

---

databaseName

Type: string

The name of the database containing the document data.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasename

---

databasePort

Type: number

The port that the database uses for connections.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databaseport

---

secretArn

Type: string

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

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-secretarn

---

tableName

Type: string

The name of the table that contains the document data.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-tablename