@aws-cdk_aws-apigatewayv2-integrations-alpha.HttpPrivateIntegrationOptions

interface HttpPrivateIntegrationOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Integrations.Alpha.HttpPrivateIntegrationOptions
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2integrationsalpha/v2#HttpPrivateIntegrationOptions
Javasoftware.amazon.awscdk.services.apigatewayv2.integrations.alpha.HttpPrivateIntegrationOptions
Pythonaws_cdk.aws_apigatewayv2_integrations_alpha.HttpPrivateIntegrationOptions
TypeScript (source)@aws-cdk/aws-apigatewayv2-integrations-alpha ยป HttpPrivateIntegrationOptions

Base options for private integration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2_alpha from '@aws-cdk/aws-apigatewayv2-alpha';
import * as apigatewayv2_integrations_alpha from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

declare const parameterMapping: apigatewayv2_alpha.ParameterMapping;
declare const vpcLink: apigatewayv2_alpha.VpcLink;
const httpPrivateIntegrationOptions: apigatewayv2_integrations_alpha.HttpPrivateIntegrationOptions = {
  method: apigatewayv2_alpha.HttpMethod.ANY,
  parameterMapping: parameterMapping,
  secureServerName: 'secureServerName',
  vpcLink: vpcLink,
};

Properties

NameTypeDescription
method?๐Ÿ”นHttpMethodThe HTTP method that must be used to invoke the underlying HTTP proxy.
parameterMapping?๐Ÿ”นParameterMappingSpecifies how to transform HTTP requests before sending them to the backend.
secureServerName?๐Ÿ”นstringSpecifies the server name to verified by HTTPS when calling the backend integration.
vpcLink?๐Ÿ”นIVpcLinkThe vpc link to be used for the private integration.

method?๐Ÿ”น

Type: HttpMethod (optional, default: HttpMethod.ANY)

The HTTP method that must be used to invoke the underlying HTTP proxy.


parameterMapping?๐Ÿ”น

Type: ParameterMapping (optional, default: undefined requests are sent to the backend unmodified)

Specifies how to transform HTTP requests before sending them to the backend.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html


secureServerName?๐Ÿ”น

Type: string (optional, default: undefined private integration traffic will use HTTP protocol)

Specifies the server name to verified by HTTPS when calling the backend integration.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html


vpcLink?๐Ÿ”น

Type: IVpcLink (optional, default: a new VpcLink is created)

The vpc link to be used for the private integration.