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

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

Overview

Note:

When making an API call, you may pass ProxyConfiguration data as a hash:

{
  host: "Host", # required
  port: 1, # required
  credentials: "SecretArn",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#credentialsString

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.

Returns:

  • (String)


9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9781

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

#hostString

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

Returns:

  • (String)


9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9781

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

#portInteger

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.

Returns:

  • (Integer)


9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9781

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