BasicAuthenticationConfiguration - Amazon Kendra API Reference

BasicAuthenticationConfiguration

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

Contents

Credentials

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

Host

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: ([^\s]*)

Required: Yes

Port

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: