software.amazon.awscdk.services.kendra

Interface CfnDataSource.ProxyConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ProxyConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.ProxyConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides the configuration information for a web proxy to connect to website hosts.

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.*;
 ProxyConfigurationProperty proxyConfigurationProperty = ProxyConfigurationProperty.builder()
         .host("host")
         .port(123)
         // the properties below are optional
         .credentials("credentials")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ProxyConfigurationProperty.Builder	builder()
default String	getCredentials() Your secret ARN, which you can create in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html).
String	getHost() The name of the website host you want to connect to via a web proxy server.
Number	getPort() The port number of the website host you want to connect to via a web proxy server.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHost

@Stability(value=Stable)
 @NotNull
String getHost()

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

getPort

@Stability(value=Stable)
 @NotNull
Number getPort()

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

getCredentials

@Stability(value=Stable)
 @Nullable
default String getCredentials()

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

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

builder

@Stability(value=Stable)
static CfnDataSource.ProxyConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ProxyConfigurationProperty.Builder of CfnDataSource.ProxyConfigurationProperty