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

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 BasicAuthenticationConfiguration data as a hash:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#credentialsString

Your secret ARN, which you can create in AWS 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)


573
574
575
576
577
578
579
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 573

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

#hostString

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)


573
574
575
576
577
578
579
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 573

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

#portInteger

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)


573
574
575
576
577
578
579
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 573

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