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

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

Overview

Note:

When making an API call, you may pass ConnectionConfiguration data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_hostString

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)

1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'lib/aws-sdk-kendra/types.rb', line 1356

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

#database_nameString

The name of the database containing the document data.

Returns:

  • (String)

1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'lib/aws-sdk-kendra/types.rb', line 1356

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

#database_portInteger

The port that the database uses for connections.

Returns:

  • (Integer)

1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'lib/aws-sdk-kendra/types.rb', line 1356

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

#secret_arnString

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 ][2] in the *AWS 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)

1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'lib/aws-sdk-kendra/types.rb', line 1356

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

#table_nameString

The name of the table that contains the document data.

Returns:

  • (String)

1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'lib/aws-sdk-kendra/types.rb', line 1356

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