aws-cdk-lib.aws_kendra.CfnDataSource.ProxyConfigurationProperty

interface ProxyConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.ProxyConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_ProxyConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.ProxyConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.ProxyConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnDataSource » 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 { aws_kendra as kendra } from 'aws-cdk-lib';
const proxyConfigurationProperty: kendra.CfnDataSource.ProxyConfigurationProperty = {
  host: 'host',
  port: 123,

  // the properties below are optional
  credentials: 'credentials',
};

Properties

NameTypeDescription
hoststringThe name of the website host you want to connect to via a web proxy server.
portnumberThe port number of the website host you want to connect to via a web proxy server.
credentials?stringYour secret ARN, which you can create in AWS Secrets Manager.

host

Type: string

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

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.


credentials?

Type: string (optional)

Your secret ARN, which you can create 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.