aws-cdk-lib.aws_apigatewayv2.CfnIntegration.TlsConfigProperty

interface TlsConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnIntegration.TlsConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnIntegration_TlsConfigProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnIntegration.TlsConfigProperty
Pythonaws_cdk.aws_apigatewayv2.CfnIntegration.TlsConfigProperty
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnIntegration » TlsConfigProperty

The TlsConfig property specifies the TLS configuration for a private integration.

If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const tlsConfigProperty: apigatewayv2.CfnIntegration.TlsConfigProperty = {
  serverNameToVerify: 'serverNameToVerify',
};

Properties

NameTypeDescription
serverNameToVerify?stringIf you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate.

serverNameToVerify?

Type: string (optional)

If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate.

The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.