Amazonka.Kendra.Types.ConnectionConfiguration

Documentation

data ConnectionConfiguration

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

See: newConnectionConfiguration smart constructor.

Constructors

ConnectionConfiguration'

Fields

• databaseHost :: Text

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

• databasePort :: Natural

  The port that the database uses for connections.

• databaseName :: Text

  The name of the database containing the document data.

• tableName :: Text

  The name of the table that contains the document data.

• secretArn :: Text

  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.

Instances

FromJSON ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

parseJSON :: Value -> Parser ConnectionConfiguration

parseJSONList :: Value -> Parser [ConnectionConfiguration]

ToJSON ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

toJSON :: ConnectionConfiguration -> Value

toEncoding :: ConnectionConfiguration -> Encoding

toJSONList :: [ConnectionConfiguration] -> Value

toEncodingList :: [ConnectionConfiguration] -> Encoding

Generic ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Associated Types

type Rep ConnectionConfiguration :: Type -> Type

Methods

from :: ConnectionConfiguration -> Rep ConnectionConfiguration x

to :: Rep ConnectionConfiguration x -> ConnectionConfiguration

Read ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

readsPrec :: Int -> ReadS ConnectionConfiguration

readList :: ReadS [ConnectionConfiguration]

readPrec :: ReadPrec ConnectionConfiguration

readListPrec :: ReadPrec [ConnectionConfiguration]

Show ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

showsPrec :: Int -> ConnectionConfiguration -> ShowS

show :: ConnectionConfiguration -> String

showList :: [ConnectionConfiguration] -> ShowS

NFData ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

rnf :: ConnectionConfiguration -> ()

Eq ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

(==) :: ConnectionConfiguration -> ConnectionConfiguration -> Bool

(/=) :: ConnectionConfiguration -> ConnectionConfiguration -> Bool

Hashable ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

hashWithSalt :: Int -> ConnectionConfiguration -> Int

hash :: ConnectionConfiguration -> Int

type Rep ConnectionConfiguration

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

type Rep ConnectionConfiguration = D1 ('MetaData "ConnectionConfiguration" "Amazonka.Kendra.Types.ConnectionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConnectionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "databaseHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "databasePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newConnectionConfiguration

Arguments

:: Text

$sel:databaseHost:ConnectionConfiguration'

-> Natural

$sel:databasePort:ConnectionConfiguration'

-> Text

$sel:databaseName:ConnectionConfiguration'

-> Text

$sel:tableName:ConnectionConfiguration'

-> Text

$sel:secretArn:ConnectionConfiguration'

-> ConnectionConfiguration

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

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

The port that the database uses for connections.

connectionConfiguration_databaseName :: Lens' ConnectionConfiguration Text

The name of the database containing the document data.

connectionConfiguration_tableName :: Lens' ConnectionConfiguration Text

The name of the table that contains the document data.

connectionConfiguration_secretArn :: Lens' ConnectionConfiguration Text

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.