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();
 
  • Method Details

    • getCredentials

      @Stability(Stable) @NotNull String getCredentials()
      Your secret ARN, which you can create in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html).

      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.

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

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

    • builder

      Returns:
      a CfnDataSource.WebCrawlerBasicAuthenticationProperty.Builder of CfnDataSource.WebCrawlerBasicAuthenticationProperty