Class: Aws::Kendra::Types::ProxyConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#credentials ⇒ String

The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a secret to store your credentials 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.

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html

Returns:

  • (String) 


7789
7790
7791
7792
7793
7794
7795
 
# File 'lib/aws-sdk-kendra/types.rb', line 7789

class ProxyConfiguration < Struct.new(
  :host,
  :port,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#host ⇒ String

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

For example, the host name of a.example.com/page1.html is “a.example.com”.

Returns:

  • (String) 


7789
7790
7791
7792
7793
7794
7795
 
# File 'lib/aws-sdk-kendra/types.rb', line 7789

class ProxyConfiguration < Struct.new(
  :host,
  :port,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

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

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

Returns:

  • (Integer) 


7789
7790
7791
7792
7793
7794
7795
 
# File 'lib/aws-sdk-kendra/types.rb', line 7789

class ProxyConfiguration < Struct.new(
  :host,
  :port,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end