Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.Kendra.Types.ConnectionConfiguration
Description
Synopsis
- data ConnectionConfiguration = ConnectionConfiguration' {
- databaseHost :: Text
- databasePort :: Natural
- databaseName :: Text
- tableName :: Text
- secretArn :: Text
- newConnectionConfiguration :: Text -> Natural -> Text -> Text -> Text -> ConnectionConfiguration
- connectionConfiguration_databaseHost :: Lens' ConnectionConfiguration Text
- connectionConfiguration_databasePort :: Lens' ConnectionConfiguration Natural
- connectionConfiguration_databaseName :: Lens' ConnectionConfiguration Text
- connectionConfiguration_tableName :: Lens' ConnectionConfiguration Text
- connectionConfiguration_secretArn :: Lens' ConnectionConfiguration Text
Documentation
data ConnectionConfiguration Source #
Provides the configuration information that's required to connect to a database.
See: newConnectionConfiguration
smart constructor.
Constructors
ConnectionConfiguration' | |
Fields
|
Instances
newConnectionConfiguration Source #
Create a value of ConnectionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:databaseHost:ConnectionConfiguration'
, connectionConfiguration_databaseHost
- The name of the host for the database. Can be either a string
(host.subdomain.domain.tld) or an IPv4 or IPv6 address.
$sel:databasePort:ConnectionConfiguration'
, connectionConfiguration_databasePort
- The port that the database uses for connections.
$sel:databaseName:ConnectionConfiguration'
, connectionConfiguration_databaseName
- The name of the database containing the document data.
$sel:tableName:ConnectionConfiguration'
, connectionConfiguration_tableName
- The name of the table that contains the document data.
$sel:secretArn:ConnectionConfiguration'
, connectionConfiguration_secretArn
- The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
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.
connectionConfiguration_databaseHost :: Lens' ConnectionConfiguration Text Source #
The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
connectionConfiguration_databasePort :: Lens' ConnectionConfiguration Natural Source #
The port that the database uses for connections.
connectionConfiguration_databaseName :: Lens' ConnectionConfiguration Text Source #
The name of the database containing the document data.
connectionConfiguration_tableName :: Lens' ConnectionConfiguration Text Source #
The name of the table that contains the document data.
connectionConfiguration_secretArn :: Lens' ConnectionConfiguration Text Source #
The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. 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.