You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::ConnectionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ConnectionConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  database_host: "DatabaseHost", # required
  database_port: 1, # required
  database_name: "DatabaseName", # required
  table_name: "TableName", # required
  secret_arn: "SecretArn", # required
}

Provides the information necessary to connect to a database.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#database_host ⇒ String

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

Returns:

  • (String) —

    The name of the host for the database.

#database_name ⇒ String

The name of the database containing the document data.

Returns:

  • (String) —

    The name of the database containing the document data.

#database_port ⇒ Integer

The port that the database uses for connections.

Returns:

  • (Integer) —

    The port that the database uses for connections.

#secret_arn ⇒ 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.

Returns:

  • (String) —

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

#table_name ⇒ String

The name of the table that contains the document data.

Returns:

  • (String) —

    The name of the table that contains the document data.