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.BasicAuthenticationConfiguration

Description

Documentation

data BasicAuthenticationConfiguration Source #

Provides the configuration information to connect to websites that require basic user authentication.

See: newBasicAuthenticationConfiguration smart constructor.

Constructors

BasicAuthenticationConfiguration'

Fields

host :: Text
The name of the website host you want to connect to using authentication credentials.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
port :: Natural
The port number of the website host you want to connect to using authentication credentials.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
credentials :: Text
Your secret ARN, which you can create in Secrets Manager
You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

Instances

Instances details

FromJSON BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods parseJSON :: Value -> Parser BasicAuthenticationConfiguration # parseJSONList :: Value -> Parser [BasicAuthenticationConfiguration] #
ToJSON BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods toJSON :: BasicAuthenticationConfiguration -> Value # toEncoding :: BasicAuthenticationConfiguration -> Encoding # toJSONList :: [BasicAuthenticationConfiguration] -> Value # toEncodingList :: [BasicAuthenticationConfiguration] -> Encoding #
Generic BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Associated Types type Rep BasicAuthenticationConfiguration :: Type -> Type # Methods from :: BasicAuthenticationConfiguration -> Rep BasicAuthenticationConfiguration x # to :: Rep BasicAuthenticationConfiguration x -> BasicAuthenticationConfiguration #
Read BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods readsPrec :: Int -> ReadS BasicAuthenticationConfiguration # readList :: ReadS [BasicAuthenticationConfiguration] # readPrec :: ReadPrec BasicAuthenticationConfiguration # readListPrec :: ReadPrec [BasicAuthenticationConfiguration] #
Show BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods showsPrec :: Int -> BasicAuthenticationConfiguration -> ShowS # show :: BasicAuthenticationConfiguration -> String # showList :: [BasicAuthenticationConfiguration] -> ShowS #
NFData BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods rnf :: BasicAuthenticationConfiguration -> () #
Eq BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods (==) :: BasicAuthenticationConfiguration -> BasicAuthenticationConfiguration -> Bool # (/=) :: BasicAuthenticationConfiguration -> BasicAuthenticationConfiguration -> Bool #
Hashable BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods hashWithSalt :: Int -> BasicAuthenticationConfiguration -> Int # hash :: BasicAuthenticationConfiguration -> Int #
type Rep BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration type Rep BasicAuthenticationConfiguration = D1 ('MetaData "BasicAuthenticationConfiguration" "Amazonka.Kendra.Types.BasicAuthenticationConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BasicAuthenticationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newBasicAuthenticationConfiguration Source #

Arguments

:: Text	`$sel:host:BasicAuthenticationConfiguration'`
-> Natural	`$sel:port:BasicAuthenticationConfiguration'`
-> Text	`$sel:credentials:BasicAuthenticationConfiguration'`
-> BasicAuthenticationConfiguration

Create a value of BasicAuthenticationConfiguration 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:host:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_host - The name of the website host you want to connect to using authentication credentials.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

$sel:port:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_port - The port number of the website host you want to connect to using authentication credentials.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

$sel:credentials:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_credentials - Your secret ARN, which you can create in Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

basicAuthenticationConfiguration_host :: Lens' BasicAuthenticationConfiguration Text Source #

The name of the website host you want to connect to using authentication credentials.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

basicAuthenticationConfiguration_port :: Lens' BasicAuthenticationConfiguration Natural Source #

The port number of the website host you want to connect to using authentication credentials.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

basicAuthenticationConfiguration_credentials :: Lens' BasicAuthenticationConfiguration Text Source #

Your secret ARN, which you can create in Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.