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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/aws-sdk-kendra/types.rb', line 1818

class ConnectionConfiguration < Struct.new(
  :database_host,
  :database_port,
  :database_name,
  :table_name,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The name of the database containing the document data.

Returns:

  • (String) 


1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/aws-sdk-kendra/types.rb', line 1818

class ConnectionConfiguration < Struct.new(
  :database_host,
  :database_port,
  :database_name,
  :table_name,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#database_port ⇒ Integer

The port that the database uses for connections.

Returns:

  • (Integer) 


1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/aws-sdk-kendra/types.rb', line 1818

class ConnectionConfiguration < Struct.new(
  :database_host,
  :database_port,
  :database_name,
  :table_name,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an 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 Secrets Manager, see [ What Is Secrets Manager] in the *Secrets Manager* user guide.

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-database.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html

Returns:

  • (String) 


1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/aws-sdk-kendra/types.rb', line 1818

class ConnectionConfiguration < Struct.new(
  :database_host,
  :database_port,
  :database_name,
  :table_name,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the table that contains the document data.

Returns:

  • (String) 


1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/aws-sdk-kendra/types.rb', line 1818

class ConnectionConfiguration < Struct.new(
  :database_host,
  :database_port,
  :database_name,
  :table_name,
  :secret_arn)
  SENSITIVE = []
  include Aws::Structure
end