AWS CDK Reference

Appearance

v2.276.0

HttpServiceDiscoveryIntegrationProps Struct ​

Properties to initialize HttpServiceDiscoveryIntegration.

Source
aws-apigatewayv2-integrations/lib/http/service-discovery.ts
Type last changed
v2.114.0 · 5 Dec 2023

Example ​

ts
import * as servicediscovery from 'aws-cdk-lib/aws-servicediscovery';
import { HttpServiceDiscoveryIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';

const vpc = new ec2.Vpc(this, 'VPC');
const vpcLink = new apigwv2.VpcLink(this, 'VpcLink', { vpc });
const namespace = new servicediscovery.PrivateDnsNamespace(this, 'Namespace', {
  name: 'boobar.com',
  vpc,
});
const service = namespace.createService('Service');

const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
  defaultIntegration: new HttpServiceDiscoveryIntegration('DefaultIntegration', service, {
    vpcLink,
  }),
});

Properties ​

methodoptionalHttpMethodmethodoptionalHttpMethodmethodoptionalHttpMethodMethodoptionalHttpMethodMethodoptionalHttpMethod= HttpMethod.ANY#
The HTTP method that must be used to invoke the underlying HTTP proxy.
parameterMappingoptionalParameterMappingparameter_mappingoptionalParameterMappingparameterMappingoptionalParameterMappingParameterMappingoptionalParameterMappingParameterMappingoptionalParameterMapping#
Specifies how to transform HTTP requests before sending them to the backend.

Default: undefined requests are sent to the backend unmodified

secureServerNameoptionalstringsecure_server_nameoptionalstrsecureServerNameoptionalStringSecureServerNameoptionalstringSecureServerNameoptional*string#
Specifies the server name to verified by HTTPS when calling the backend integration.

Default: undefined private integration traffic will use HTTP protocol

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Duration.seconds(29)#
The maximum amount of time an integration will run before it returns without a response.

Must be between 50 milliseconds and 29 seconds.