Amazonka.Kendra.Types.ProxyConfiguration

Documentation

data ProxyConfiguration

Provides the configuration information for a web proxy to connect to website hosts.

See: newProxyConfiguration smart constructor.

Constructors

ProxyConfiguration'

Fields

• credentials :: Maybe Text

  Your secret ARN, which you can create in Secrets Manager

  The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

• host :: Text

  The name of the website host you want to connect to via a web proxy server.

  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 via a web proxy server.

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

Instances

FromJSON ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

parseJSON :: Value -> Parser ProxyConfiguration

parseJSONList :: Value -> Parser [ProxyConfiguration]

ToJSON ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

toJSON :: ProxyConfiguration -> Value

toEncoding :: ProxyConfiguration -> Encoding

toJSONList :: [ProxyConfiguration] -> Value

toEncodingList :: [ProxyConfiguration] -> Encoding

Generic ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Associated Types

type Rep ProxyConfiguration :: Type -> Type

Methods

from :: ProxyConfiguration -> Rep ProxyConfiguration x

to :: Rep ProxyConfiguration x -> ProxyConfiguration

Read ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

readsPrec :: Int -> ReadS ProxyConfiguration

readList :: ReadS [ProxyConfiguration]

readPrec :: ReadPrec ProxyConfiguration

readListPrec :: ReadPrec [ProxyConfiguration]

Show ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

showsPrec :: Int -> ProxyConfiguration -> ShowS

show :: ProxyConfiguration -> String

showList :: [ProxyConfiguration] -> ShowS

NFData ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

rnf :: ProxyConfiguration -> ()

Eq ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

(==) :: ProxyConfiguration -> ProxyConfiguration -> Bool

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

Hashable ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

hashWithSalt :: Int -> ProxyConfiguration -> Int

hash :: ProxyConfiguration -> Int

type Rep ProxyConfiguration

Defined in Amazonka.Kendra.Types.ProxyConfiguration

type Rep ProxyConfiguration = D1 ('MetaData "ProxyConfiguration" "Amazonka.Kendra.Types.ProxyConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ProxyConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newProxyConfiguration

Arguments

:: Text

$sel:host:ProxyConfiguration'

-> Natural

$sel:port:ProxyConfiguration'

-> ProxyConfiguration

Create a value of ProxyConfiguration 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:credentials:ProxyConfiguration', proxyConfiguration_credentials - Your secret ARN, which you can create in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

$sel:host:ProxyConfiguration', proxyConfiguration_host - The name of the website host you want to connect to via a web proxy server.

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

$sel:port:ProxyConfiguration', proxyConfiguration_port - The port number of the website host you want to connect to via a web proxy server.

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

proxyConfiguration_credentials :: Lens' ProxyConfiguration (Maybe Text)

Your secret ARN, which you can create in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

proxyConfiguration_host :: Lens' ProxyConfiguration Text

The name of the website host you want to connect to via a web proxy server.

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

proxyConfiguration_port :: Lens' ProxyConfiguration Natural

The port number of the website host you want to connect to via a web proxy server.

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