AWS::Kendra::DataSource ConnectionConfiguration - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Kendra::DataSource ConnectionConfiguration

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DatabaseHost" : String,
  "DatabaseName" : String,
  "DatabasePort" : Integer,
  "SecretArn" : String,
  "TableName" : String
}

YAML

  DatabaseHost: String
  DatabaseName: String
  DatabasePort: Integer
  SecretArn: String
  TableName: String

Properties

DatabaseHost

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Required: Yes

Type: String

Minimum: 1

Maximum: 253

Update requires: No interruption

DatabaseName

The name of the database containing the document data.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

DatabasePort

The port that the database uses for connections.

Required: Yes

Type: Integer

Minimum: 1

Maximum: 65535

Update requires: No interruption

SecretArn

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.

Required: Yes

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Minimum: 1

Maximum: 1284

Update requires: No interruption

TableName

The name of the table that contains the document data.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption