# ConnectionConfigurationProperty

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

- Source: Generated at build time
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

TypeScript:

```ts
// 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',
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

connection_configuration_property = kendra.CfnDataSource.ConnectionConfigurationProperty(
    database_host="databaseHost",
    database_name="databaseName",
    database_port=123,
    secret_arn="secretArn",
    table_name="tableName"
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

ConnectionConfigurationProperty connectionConfigurationProperty = ConnectionConfigurationProperty.builder()
        .databaseHost("databaseHost")
        .databaseName("databaseName")
        .databasePort(123)
        .secretArn("secretArn")
        .tableName("tableName")
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var connectionConfigurationProperty = new ConnectionConfigurationProperty {
    DatabaseHost = "databaseHost",
    DatabaseName = "databaseName",
    DatabasePort = 123,
    SecretArn = "secretArn",
    TableName = "tableName"
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

connectionConfigurationProperty := &ConnectionConfigurationProperty{
	DatabaseHost: jsii.String("databaseHost"),
	DatabaseName: jsii.String("databaseName"),
	DatabasePort: jsii.Number(123),
	SecretArn: jsii.String("secretArn"),
	TableName: jsii.String("tableName"),
}
```

## Properties

- `databaseHost`: string (required) — The name of the host for the database.

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

- `databaseName`: string (required) — The name of the database containing the document data.

- `databasePort`: number (required) — The port that the database uses for connections.

- `secretArn`: string (required) — 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](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html) . For more information about AWS Secrets Manager , see [What Is AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the *AWS Secrets Manager* user guide.

- `tableName`: string (required) — The name of the table that contains the document data.
