Amazonka.Kendra.Types.DatabaseConfiguration

Documentation

data DatabaseConfiguration

Provides the configuration information to connect to a index.

See: newDatabaseConfiguration smart constructor.

Constructors

DatabaseConfiguration'

Fields

• aclConfiguration :: Maybe AclConfiguration

  Information about the database column that provides information for user context filtering.

• sqlConfiguration :: Maybe SqlConfiguration

  Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

• vpcConfiguration :: Maybe DataSourceVpcConfiguration
• databaseEngineType :: DatabaseEngineType

  The type of database engine that runs the database.

• connectionConfiguration :: ConnectionConfiguration

  Configuration information that's required to connect to a database.

• columnConfiguration :: ColumnConfiguration

  Information about where the index should get the document information from the database.

Instances

FromJSON DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

parseJSON :: Value -> Parser DatabaseConfiguration

parseJSONList :: Value -> Parser [DatabaseConfiguration]

ToJSON DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

toJSON :: DatabaseConfiguration -> Value

toEncoding :: DatabaseConfiguration -> Encoding

toJSONList :: [DatabaseConfiguration] -> Value

toEncodingList :: [DatabaseConfiguration] -> Encoding

Generic DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Associated Types

type Rep DatabaseConfiguration :: Type -> Type

Methods

from :: DatabaseConfiguration -> Rep DatabaseConfiguration x

to :: Rep DatabaseConfiguration x -> DatabaseConfiguration

Read DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

readsPrec :: Int -> ReadS DatabaseConfiguration

readList :: ReadS [DatabaseConfiguration]

readPrec :: ReadPrec DatabaseConfiguration

readListPrec :: ReadPrec [DatabaseConfiguration]

Show DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

showsPrec :: Int -> DatabaseConfiguration -> ShowS

show :: DatabaseConfiguration -> String

showList :: [DatabaseConfiguration] -> ShowS

NFData DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

rnf :: DatabaseConfiguration -> ()

Eq DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

(==) :: DatabaseConfiguration -> DatabaseConfiguration -> Bool

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

Hashable DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

hashWithSalt :: Int -> DatabaseConfiguration -> Int

hash :: DatabaseConfiguration -> Int

type Rep DatabaseConfiguration

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

type Rep DatabaseConfiguration = D1 ('MetaData "DatabaseConfiguration" "Amazonka.Kendra.Types.DatabaseConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DatabaseConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aclConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AclConfiguration)) :*: (S1 ('MetaSel ('Just "sqlConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SqlConfiguration)) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :*: (S1 ('MetaSel ('Just "databaseEngineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DatabaseEngineType) :*: (S1 ('MetaSel ('Just "connectionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConnectionConfiguration) :*: S1 ('MetaSel ('Just "columnConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ColumnConfiguration)))))

newDatabaseConfiguration

Arguments

:: DatabaseEngineType

$sel:databaseEngineType:DatabaseConfiguration'

-> ConnectionConfiguration

$sel:connectionConfiguration:DatabaseConfiguration'

-> ColumnConfiguration

$sel:columnConfiguration:DatabaseConfiguration'

-> DatabaseConfiguration

Create a value of DatabaseConfiguration 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:aclConfiguration:DatabaseConfiguration', databaseConfiguration_aclConfiguration - Information about the database column that provides information for user context filtering.

$sel:sqlConfiguration:DatabaseConfiguration', databaseConfiguration_sqlConfiguration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

$sel:vpcConfiguration:DatabaseConfiguration', databaseConfiguration_vpcConfiguration - Undocumented member.

$sel:databaseEngineType:DatabaseConfiguration', databaseConfiguration_databaseEngineType - The type of database engine that runs the database.

$sel:connectionConfiguration:DatabaseConfiguration', databaseConfiguration_connectionConfiguration - Configuration information that's required to connect to a database.

$sel:columnConfiguration:DatabaseConfiguration', databaseConfiguration_columnConfiguration - Information about where the index should get the document information from the database.

databaseConfiguration_aclConfiguration :: Lens' DatabaseConfiguration (Maybe AclConfiguration)

Information about the database column that provides information for user context filtering.

databaseConfiguration_sqlConfiguration :: Lens' DatabaseConfiguration (Maybe SqlConfiguration)

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

databaseConfiguration_vpcConfiguration :: Lens' DatabaseConfiguration (Maybe DataSourceVpcConfiguration)

Undocumented member.

databaseConfiguration_databaseEngineType :: Lens' DatabaseConfiguration DatabaseEngineType

The type of database engine that runs the database.

databaseConfiguration_connectionConfiguration :: Lens' DatabaseConfiguration ConnectionConfiguration

Configuration information that's required to connect to a database.

databaseConfiguration_columnConfiguration :: Lens' DatabaseConfiguration ColumnConfiguration

Information about where the index should get the document information from the database.