Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.WebCrawlerBasicAuthenticationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.WebCrawlerBasicAuthenticationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.WebCrawlerBasicAuthenticationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.kendra.*;
 WebCrawlerBasicAuthenticationProperty webCrawlerBasicAuthenticationProperty = WebCrawlerBasicAuthenticationProperty.builder()
         .credentials("credentials")
         .host("host")
         .port(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.WebCrawlerBasicAuthenticationProperty.Builder	A builder for CfnDataSource.WebCrawlerBasicAuthenticationProperty
static final class	CfnDataSource.WebCrawlerBasicAuthenticationProperty.Jsii$Proxy	An implementation for CfnDataSource.WebCrawlerBasicAuthenticationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.WebCrawlerBasicAuthenticationProperty.Builder	builder()
String	getCredentials()	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.
String	getHost()	The name of the website host you want to connect to using authentication credentials.
Number	getPort()	The port number of the website host you want to connect to using authentication credentials.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCredentials

@Stability(Stable)
@NotNull
String getCredentials()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-credentials

getHost

@Stability(Stable)
@NotNull
String getHost()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-host

getPort

@Stability(Stable)
@NotNull
Number getPort()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-port

builder

@Stability(Stable)
static CfnDataSource.WebCrawlerBasicAuthenticationProperty.Builder builder()

Returns:

a CfnDataSource.WebCrawlerBasicAuthenticationProperty.Builder of CfnDataSource.WebCrawlerBasicAuthenticationProperty