interface ProxyConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnDataSourcePropsMixin.ProxyConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnDataSourcePropsMixin_ProxyConfigurationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin.ProxyConfigurationProperty`
Python	`aws_cdk.mixins_preview.aws_kendra.mixins.CfnDataSourcePropsMixin.ProxyConfigurationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_kendra` » `mixins` » `CfnDataSourcePropsMixin` » `ProxyConfigurationProperty`

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 { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const proxyConfigurationProperty: kendra_mixins.CfnDataSourcePropsMixin.ProxyConfigurationProperty = {
  credentials: 'credentials',
  host: 'host',
  port: 123,
};

Properties

Name	Type	Description
credentials?	`string`	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.
host?	`string`	The name of the website host you want to connect to via a web proxy server.
port?	`number`	The port number of the website host you want to connect to via a web proxy server.

credentials?

Type: string (optional)

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.

host?

Type: string (optional)

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

port?

Type: number (optional)

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.

AWS CDK