Package 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(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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.ProxyConfigurationProperty.Builder	builder()
default 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 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 Details

getHost

@Stability(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".

See Also:

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

getPort

@Stability(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.

See Also:

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

getCredentials

@Stability(Stable)
@Nullable
default 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

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.

See Also:

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

builder

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

Returns:

a CfnDataSource.ProxyConfigurationProperty.Builder of CfnDataSource.ProxyConfigurationProperty