Skip to content
v2.277.0

WebCrawlerBasicAuthenticationProperty Struct ​

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

Example ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

web_crawler_basic_authentication_property = kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty(
    credentials="credentials",
    host="host",
    port=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

WebCrawlerBasicAuthenticationProperty webCrawlerBasicAuthenticationProperty = WebCrawlerBasicAuthenticationProperty.builder()
        .credentials("credentials")
        .host("host")
        .port(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var webCrawlerBasicAuthenticationProperty = new WebCrawlerBasicAuthenticationProperty {
    Credentials = "credentials",
    Host = "host",
    Port = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

webCrawlerBasicAuthenticationProperty := &WebCrawlerBasicAuthenticationProperty{
	Credentials: jsii.String("credentials"),
	Host: jsii.String("host"),
	Port: jsii.Number(123),
}

Properties ​

credentialsstringcredentialsstrcredentialsStringCredentialsstringCredentials*string required #
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*string required #
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*float64 required #
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.