aws-cdk-lib.aws_kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty

interface WebCrawlerBasicAuthenticationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_WebCrawlerBasicAuthenticationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnDataSource » WebCrawlerBasicAuthenticationProperty

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

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

NameTypeDescription
credentialsstringYour secret ARN, which you can create in AWS Secrets Manager.
hoststringThe name of the website host you want to connect to using authentication credentials.
portnumberThe port number of the website host you want to connect to using authentication credentials.

credentials

Type: string

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.


host

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


port

Type: number

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.