Class: Aws::Kendra::Types::BasicAuthenticationConfiguration

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

Overview

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

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

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.

Returns:

  • (String) 


650
651
652
653
654
655
656
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 650

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

#host ⇒ String

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

Returns:

  • (String) 


650
651
652
653
654
655
656
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 650

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

#port ⇒ Integer

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.

Returns:

  • (Integer) 


650
651
652
653
654
655
656
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 650

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