Skip to content

ConnectionConfiguration

Source code in docs_src/capo_kendra/types/connection_configuration.py 
17
18
19
20
21
22
23
24
25
26
27
class ConnectionConfiguration(TypedDict, closed=True):
    database_host: "capo_kendra.types.database_host.DatabaseHost"
    """<p>The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.</p>"""
    database_port: "capo_kendra.types.database_port.DatabasePort"
    """<p>The port that the database uses for connections.</p>"""
    database_name: "capo_kendra.types.database_name.DatabaseName"
    """<p>The name of the database containing the document data.</p>"""
    table_name: "capo_kendra.types.table_name.TableName"
    """<p>The name of the table that contains the document data.</p>"""
    secret_arn: "capo_kendra.types.secret_arn.SecretArn"
    """<p>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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html">Using a Database Data Source</a>. For more information about Secrets Manager, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"> What Is Secrets Manager</a> in the <i>Secrets Manager</i> user guide.</p>"""

database_host instance-attribute 

database_host: DatabaseHost

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

database_name instance-attribute 

database_name: DatabaseName

The name of the database containing the document data.

database_port instance-attribute 

database_port: DatabasePort

The port that the database uses for connections.

secret_arn instance-attribute 

secret_arn: SecretArn

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.

table_name instance-attribute 

table_name: TableName

The name of the table that contains the document data.