aws-cdk-lib.aws_kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty

WebCrawlerBasicAuthenticationProperty Struct

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const webCrawlerBasicAuthenticationProperty: kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty = {
  credentials: 'credentials',
  host: 'host',
  port: 123,
};

Properties

credentialsstringcredentialsstrcredentialsStringCredentialsstringCredentials*stringrequired#

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.

notes

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.

hoststringhoststrhostStringHoststringHost*stringrequired#

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

portnumberportint | floatportNumberPortdoublePort*float64required#

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.