@aws-cdk_aws-apigatewayv2-alpha.HttpRouteIntegrationConfig

interface HttpRouteIntegrationConfig ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.HttpRouteIntegrationConfig
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#HttpRouteIntegrationConfig
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.HttpRouteIntegrationConfig
Pythonaws_cdk.aws_apigatewayv2_alpha.HttpRouteIntegrationConfig
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป HttpRouteIntegrationConfig

Obtainable from HttpRouteIntegration.bind(), HttpAlbIntegration.bind(), HttpLambdaIntegration.bind(), HttpNlbIntegration.bind(), HttpServiceDiscoveryIntegration.bind(), HttpUrlIntegration.bind()

Config returned back as a result of the bind.

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';

declare const integrationCredentials: apigatewayv2_alpha.IntegrationCredentials;
declare const parameterMapping: apigatewayv2_alpha.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2_alpha.PayloadFormatVersion;
const httpRouteIntegrationConfig: apigatewayv2_alpha.HttpRouteIntegrationConfig = {
  payloadFormatVersion: payloadFormatVersion,
  type: apigatewayv2_alpha.HttpIntegrationType.HTTP_PROXY,

  // the properties below are optional
  connectionId: 'connectionId',
  connectionType: apigatewayv2_alpha.HttpConnectionType.VPC_LINK,
  credentials: integrationCredentials,
  method: apigatewayv2_alpha.HttpMethod.ANY,
  parameterMapping: parameterMapping,
  secureServerName: 'secureServerName',
  subtype: apigatewayv2_alpha.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
  uri: 'uri',
};

Properties

NameTypeDescription
payloadFormatVersion๐Ÿ”นPayloadFormatVersionPayload format version in the case of lambda proxy integration.
type๐Ÿ”นHttpIntegrationTypeIntegration type.
connectionId?๐Ÿ”นstringThe ID of the VPC link for a private integration.
connectionType?๐Ÿ”นHttpConnectionTypeThe type of the network connection to the integration endpoint.
credentials?๐Ÿ”นIntegrationCredentialsThe credentials with which to invoke the integration.
method?๐Ÿ”นHttpMethodThe HTTP method that must be used to invoke the underlying 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.
subtype?๐Ÿ”นHttpIntegrationSubtypeIntegration subtype.
uri?๐Ÿ”นstringIntegration URI.

payloadFormatVersion๐Ÿ”น

Type: PayloadFormatVersion

Payload format version in the case of lambda proxy integration.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html


type๐Ÿ”น

Type: HttpIntegrationType

Integration type.


connectionId?๐Ÿ”น

Type: string (optional, default: undefined)

The ID of the VPC link for a private integration.

Supported only for HTTP APIs.


connectionType?๐Ÿ”น

Type: HttpConnectionType (optional, default: HttpConnectionType.INTERNET)

The type of the network connection to the integration endpoint.


credentials?๐Ÿ”น

Type: IntegrationCredentials (optional, default: no credentials, use resource-based permissions on supported AWS services)

The credentials with which to invoke the integration.


method?๐Ÿ”น

Type: HttpMethod (optional, default: undefined)

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

Required for HttpIntegrationType.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


subtype?๐Ÿ”น

Type: HttpIntegrationSubtype (optional, default: none, required if no integrationUri is defined.)

Integration subtype.


uri?๐Ÿ”น

Type: string (optional, default: none, required if no integrationSubtype is defined.)

Integration URI.