Skip to content
v2.278.0

ProxyConfigurationProperty Struct ​

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

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

proxy_configuration_property = kendra.CfnDataSource.ProxyConfigurationProperty(
    host="host",
    port=123,

    # the properties below are optional
    credentials="credentials"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var proxyConfigurationProperty = new ProxyConfigurationProperty {
    Host = "host",
    Port = 123,

    // the properties below are optional
    Credentials = "credentials"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

proxyConfigurationProperty := &ProxyConfigurationProperty{
	Host: jsii.String("host"),
	Port: jsii.Number(123),

	// the properties below are optional
	Credentials: jsii.String("credentials"),
}

Properties ​

credentialsoptionalstringcredentialsoptionalstrcredentialsoptionalStringCredentialsoptionalstringCredentialsoptional*string #
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.
notes

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.

hoststringhoststrhostStringHoststringHost*string required #
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".

portnumberportint | floatportNumberPortdoublePort*float64 required #
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.