awscdkapigatewayv2integrationsalpha

package module
v2.0.0-alpha.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 25, 2021 License: Apache-2.0 Imports: 8 Imported by: 6

README

AWS APIGatewayv2 Integrations

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

Table of Contents

HTTP APIs

Integrations connect a route to backend resources. HTTP APIs support Lambda proxy, AWS service, and HTTP proxy integrations. HTTP proxy integrations are also known as private integrations.

Lambda

Lambda integrations enable integrating an HTTP API route with a Lambda function. When a client invokes the route, the API Gateway service forwards the request to the Lambda function and returns the function's response to the client.

The API Gateway service will invoke the lambda function with an event payload of a specific format. The service expects the function to respond in a specific format. The details on this format is available at Working with AWS Lambda proxy integrations.

The following code configures a route GET /books with a Lambda proxy integration.

import { LambdaProxyIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

declare const booksDefaultFn: lambda.Function;
const booksIntegration = new LambdaProxyIntegration({
  handler: booksDefaultFn,
});

const httpApi = new apigwv2.HttpApi(this, 'HttpApi');

httpApi.addRoutes({
  path: '/books',
  methods: [ apigwv2.HttpMethod.GET ],
  integration: booksIntegration,
});
HTTP Proxy

HTTP Proxy integrations enables connecting an HTTP API route to a publicly routable HTTP endpoint. When a client invokes the route, the API Gateway service forwards the entire request and response between the API Gateway endpoint and the integrating HTTP endpoint. More information can be found at Working with HTTP proxy integrations.

The following code configures a route GET /books with an HTTP proxy integration to an HTTP endpoint get-books-proxy.myproxy.internal.

import { HttpProxyIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

const booksIntegration = new HttpProxyIntegration({
  url: 'https://get-books-proxy.myproxy.internal',
});

const httpApi = new apigwv2.HttpApi(this, 'HttpApi');

httpApi.addRoutes({
  path: '/books',
  methods: [ apigwv2.HttpMethod.GET ],
  integration: booksIntegration,
});
Private Integration

Private integrations enable integrating an HTTP API route with private resources in a VPC, such as Application Load Balancers or Amazon ECS container-based applications. Using private integrations, resources in a VPC can be exposed for access by clients outside of the VPC.

The following integrations are supported for private resources in a VPC.

Application Load Balancer

The following code is a basic application load balancer private integration of HTTP API:

import { HttpAlbIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

const vpc = new ec2.Vpc(this, 'VPC');
const lb = new elbv2.ApplicationLoadBalancer(this, 'lb', { vpc });
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
  port: 80,
});

const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
  defaultIntegration: new HttpAlbIntegration({
    listener,
  }),
});

When an imported load balancer is used, the vpc option must be specified for HttpAlbIntegration.

Network Load Balancer

The following code is a basic network load balancer private integration of HTTP API:

import { HttpNlbIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

const vpc = new ec2.Vpc(this, 'VPC');
const lb = new elbv2.NetworkLoadBalancer(this, 'lb', { vpc });
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
  port: 80,
});

const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
  defaultIntegration: new HttpNlbIntegration({
    listener,
  }),
});

When an imported load balancer is used, the vpc option must be specified for HttpNlbIntegration.

Cloud Map Service Discovery

The following code is a basic discovery service private integration of HTTP API:

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

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({
    vpcLink,
    service,
  }),
});
Request Parameters

Request parameter mapping allows API requests from clients to be modified before they reach backend integrations. Parameter mapping can be used to specify modifications to request parameters. See Transforming API requests and responses.

The following example creates a new header - header2 - as a copy of header1 and removes header1.

import { HttpAlbIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

declare const lb: elbv2.ApplicationLoadBalancer;
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
  port: 80,
});

const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
  defaultIntegration: new HttpAlbIntegration({
    listener,
    parameterMapping: new apigwv2.ParameterMapping()
      .appendHeader('header2', apigwv2.MappingValue.requestHeader('header1'))
      .removeHeader('header1'),
  }),
});

To add mapping keys and values not yet supported by the CDK, use the custom() method:

import { HttpAlbIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

declare const lb: elbv2.ApplicationLoadBalancer;
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
  port: 80,
});

const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
  defaultIntegration: new HttpAlbIntegration({
    listener,
    parameterMapping: new apigwv2.ParameterMapping().custom('myKey', 'myValue'),
  }),
});

WebSocket APIs

WebSocket integrations connect a route to backend resources. The following integrations are supported in the CDK.

Lambda WebSocket Integration

Lambda integrations enable integrating a WebSocket API route with a Lambda function. When a client connects/disconnects or sends message specific to a route, the API Gateway service forwards the request to the Lambda function

The API Gateway service will invoke the lambda function with an event payload of a specific format.

The following code configures a sendmessage route with a Lambda integration

import { LambdaWebSocketIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

const webSocketApi = new apigwv2.WebSocketApi(this, 'mywsapi');
new apigwv2.WebSocketStage(this, 'mystage', {
  webSocketApi,
  stageName: 'dev',
  autoDeploy: true,
});

declare const messageHandler: lambda.Function;
webSocketApi.addRoute('sendmessage', {
  integration: new LambdaWebSocketIntegration({
    handler: messageHandler,
  }),
});

Documentation

Overview

Integrations for AWS APIGateway V2

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewHttpAlbIntegration_Override 

func NewHttpAlbIntegration_Override(h HttpAlbIntegration, props *HttpAlbIntegrationProps)

Experimental.

func NewHttpNlbIntegration_Override 

func NewHttpNlbIntegration_Override(h HttpNlbIntegration, props *HttpNlbIntegrationProps)

Experimental.

func NewHttpProxyIntegration_Override 

func NewHttpProxyIntegration_Override(h HttpProxyIntegration, props *HttpProxyIntegrationProps)

Experimental.

func NewHttpServiceDiscoveryIntegration_Override 

func NewHttpServiceDiscoveryIntegration_Override(h HttpServiceDiscoveryIntegration, props *HttpServiceDiscoveryIntegrationProps)

Experimental.

func NewLambdaProxyIntegration_Override 

func NewLambdaProxyIntegration_Override(l LambdaProxyIntegration, props *LambdaProxyIntegrationProps)

Experimental.

func NewLambdaWebSocketIntegration_Override 

func NewLambdaWebSocketIntegration_Override(l LambdaWebSocketIntegration, props *LambdaWebSocketIntegrationProps)

Experimental.

Types

type HttpAlbIntegration 

type HttpAlbIntegration interface {
	awscdkapigatewayv2alpha.IHttpRouteIntegration
	ConnectionType() awscdkapigatewayv2alpha.HttpConnectionType
	SetConnectionType(val awscdkapigatewayv2alpha.HttpConnectionType)
	HttpMethod() awscdkapigatewayv2alpha.HttpMethod
	SetHttpMethod(val awscdkapigatewayv2alpha.HttpMethod)
	IntegrationType() awscdkapigatewayv2alpha.HttpIntegrationType
	SetIntegrationType(val awscdkapigatewayv2alpha.HttpIntegrationType)
	PayloadFormatVersion() awscdkapigatewayv2alpha.PayloadFormatVersion
	SetPayloadFormatVersion(val awscdkapigatewayv2alpha.PayloadFormatVersion)
	Bind(options *awscdkapigatewayv2alpha.HttpRouteIntegrationBindOptions) *awscdkapigatewayv2alpha.HttpRouteIntegrationConfig
}

The Application Load Balancer integration resource for HTTP API.

TODO: EXAMPLE

Experimental.

func NewHttpAlbIntegration 

func NewHttpAlbIntegration(props *HttpAlbIntegrationProps) HttpAlbIntegration

Experimental.

type HttpAlbIntegrationProps 

type HttpAlbIntegrationProps struct {
	// The HTTP method that must be used to invoke the underlying HTTP proxy.
	// Experimental.
	Method awscdkapigatewayv2alpha.HttpMethod `json:"method"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping awscdkapigatewayv2alpha.ParameterMapping `json:"parameterMapping"`
	// Specifies the server name to verified by HTTPS when calling the backend integration.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html
	//
	// Experimental.
	SecureServerName *string `json:"secureServerName"`
	// The vpc link to be used for the private integration.
	// Experimental.
	VpcLink awscdkapigatewayv2alpha.IVpcLink `json:"vpcLink"`
	// The listener to the application load balancer used for the integration.
	// Experimental.
	Listener awselasticloadbalancingv2.IApplicationListener `json:"listener"`
}

Properties to initialize `HttpAlbIntegration`.

TODO: EXAMPLE

Experimental.

type HttpNlbIntegration 

type HttpNlbIntegration interface {
	awscdkapigatewayv2alpha.IHttpRouteIntegration
	ConnectionType() awscdkapigatewayv2alpha.HttpConnectionType
	SetConnectionType(val awscdkapigatewayv2alpha.HttpConnectionType)
	HttpMethod() awscdkapigatewayv2alpha.HttpMethod
	SetHttpMethod(val awscdkapigatewayv2alpha.HttpMethod)
	IntegrationType() awscdkapigatewayv2alpha.HttpIntegrationType
	SetIntegrationType(val awscdkapigatewayv2alpha.HttpIntegrationType)
	PayloadFormatVersion() awscdkapigatewayv2alpha.PayloadFormatVersion
	SetPayloadFormatVersion(val awscdkapigatewayv2alpha.PayloadFormatVersion)
	Bind(options *awscdkapigatewayv2alpha.HttpRouteIntegrationBindOptions) *awscdkapigatewayv2alpha.HttpRouteIntegrationConfig
}

The Network Load Balancer integration resource for HTTP API.

TODO: EXAMPLE

Experimental.

func NewHttpNlbIntegration 

func NewHttpNlbIntegration(props *HttpNlbIntegrationProps) HttpNlbIntegration

Experimental.

type HttpNlbIntegrationProps 

type HttpNlbIntegrationProps struct {
	// The HTTP method that must be used to invoke the underlying HTTP proxy.
	// Experimental.
	Method awscdkapigatewayv2alpha.HttpMethod `json:"method"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping awscdkapigatewayv2alpha.ParameterMapping `json:"parameterMapping"`
	// Specifies the server name to verified by HTTPS when calling the backend integration.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html
	//
	// Experimental.
	SecureServerName *string `json:"secureServerName"`
	// The vpc link to be used for the private integration.
	// Experimental.
	VpcLink awscdkapigatewayv2alpha.IVpcLink `json:"vpcLink"`
	// The listener to the network load balancer used for the integration.
	// Experimental.
	Listener awselasticloadbalancingv2.INetworkListener `json:"listener"`
}

Properties to initialize `HttpNlbIntegration`.

TODO: EXAMPLE

Experimental.

type HttpPrivateIntegrationOptions 

type HttpPrivateIntegrationOptions struct {
	// The HTTP method that must be used to invoke the underlying HTTP proxy.
	// Experimental.
	Method awscdkapigatewayv2alpha.HttpMethod `json:"method"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping awscdkapigatewayv2alpha.ParameterMapping `json:"parameterMapping"`
	// Specifies the server name to verified by HTTPS when calling the backend integration.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html
	//
	// Experimental.
	SecureServerName *string `json:"secureServerName"`
	// The vpc link to be used for the private integration.
	// Experimental.
	VpcLink awscdkapigatewayv2alpha.IVpcLink `json:"vpcLink"`
}

Base options for private integration.

TODO: EXAMPLE

Experimental.

type HttpProxyIntegration 

type HttpProxyIntegration interface {
	awscdkapigatewayv2alpha.IHttpRouteIntegration
	Bind(_arg *awscdkapigatewayv2alpha.HttpRouteIntegrationBindOptions) *awscdkapigatewayv2alpha.HttpRouteIntegrationConfig
}

The HTTP Proxy integration resource for HTTP API.

TODO: EXAMPLE

Experimental.

func NewHttpProxyIntegration 

func NewHttpProxyIntegration(props *HttpProxyIntegrationProps) HttpProxyIntegration

Experimental.

type HttpProxyIntegrationProps 

type HttpProxyIntegrationProps struct {
	// The full-qualified HTTP URL for the HTTP integration.
	// Experimental.
	Url *string `json:"url"`
	// The HTTP method that must be used to invoke the underlying HTTP proxy.
	// Experimental.
	Method awscdkapigatewayv2alpha.HttpMethod `json:"method"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping awscdkapigatewayv2alpha.ParameterMapping `json:"parameterMapping"`
}

Properties to initialize a new `HttpProxyIntegration`.

TODO: EXAMPLE

Experimental.

type HttpServiceDiscoveryIntegration 

type HttpServiceDiscoveryIntegration interface {
	awscdkapigatewayv2alpha.IHttpRouteIntegration
	ConnectionType() awscdkapigatewayv2alpha.HttpConnectionType
	SetConnectionType(val awscdkapigatewayv2alpha.HttpConnectionType)
	HttpMethod() awscdkapigatewayv2alpha.HttpMethod
	SetHttpMethod(val awscdkapigatewayv2alpha.HttpMethod)
	IntegrationType() awscdkapigatewayv2alpha.HttpIntegrationType
	SetIntegrationType(val awscdkapigatewayv2alpha.HttpIntegrationType)
	PayloadFormatVersion() awscdkapigatewayv2alpha.PayloadFormatVersion
	SetPayloadFormatVersion(val awscdkapigatewayv2alpha.PayloadFormatVersion)
	Bind(_arg *awscdkapigatewayv2alpha.HttpRouteIntegrationBindOptions) *awscdkapigatewayv2alpha.HttpRouteIntegrationConfig
}

The Service Discovery integration resource for HTTP API.

TODO: EXAMPLE

Experimental.

func NewHttpServiceDiscoveryIntegration 

func NewHttpServiceDiscoveryIntegration(props *HttpServiceDiscoveryIntegrationProps) HttpServiceDiscoveryIntegration

Experimental.

type HttpServiceDiscoveryIntegrationProps 

type HttpServiceDiscoveryIntegrationProps struct {
	// The HTTP method that must be used to invoke the underlying HTTP proxy.
	// Experimental.
	Method awscdkapigatewayv2alpha.HttpMethod `json:"method"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping awscdkapigatewayv2alpha.ParameterMapping `json:"parameterMapping"`
	// Specifies the server name to verified by HTTPS when calling the backend integration.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html
	//
	// Experimental.
	SecureServerName *string `json:"secureServerName"`
	// The vpc link to be used for the private integration.
	// Experimental.
	VpcLink awscdkapigatewayv2alpha.IVpcLink `json:"vpcLink"`
	// The discovery service used for the integration.
	// Experimental.
	Service awsservicediscovery.IService `json:"service"`
}

Properties to initialize `HttpServiceDiscoveryIntegration`.

TODO: EXAMPLE

Experimental.

type LambdaProxyIntegration 

type LambdaProxyIntegration interface {
	awscdkapigatewayv2alpha.IHttpRouteIntegration
	Bind(options *awscdkapigatewayv2alpha.HttpRouteIntegrationBindOptions) *awscdkapigatewayv2alpha.HttpRouteIntegrationConfig
}

The Lambda Proxy integration resource for HTTP API.

TODO: EXAMPLE

Experimental.

func NewLambdaProxyIntegration 

func NewLambdaProxyIntegration(props *LambdaProxyIntegrationProps) LambdaProxyIntegration

Experimental.

type LambdaProxyIntegrationProps 

type LambdaProxyIntegrationProps struct {
	// The handler for this integration.
	// Experimental.
	Handler awslambda.IFunction `json:"handler"`
	// Specifies how to transform HTTP requests before sending them to the backend.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
	//
	// Experimental.
	ParameterMapping awscdkapigatewayv2alpha.ParameterMapping `json:"parameterMapping"`
	// Version of the payload sent to the lambda handler.
	// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
	//
	// Experimental.
	PayloadFormatVersion awscdkapigatewayv2alpha.PayloadFormatVersion `json:"payloadFormatVersion"`
}

Lambda Proxy integration properties.

TODO: EXAMPLE

Experimental.

type LambdaWebSocketIntegration 

type LambdaWebSocketIntegration interface {
	awscdkapigatewayv2alpha.IWebSocketRouteIntegration
	Bind(options *awscdkapigatewayv2alpha.WebSocketRouteIntegrationBindOptions) *awscdkapigatewayv2alpha.WebSocketRouteIntegrationConfig
}

Lambda WebSocket Integration.

TODO: EXAMPLE

Experimental.

func NewLambdaWebSocketIntegration 

func NewLambdaWebSocketIntegration(props *LambdaWebSocketIntegrationProps) LambdaWebSocketIntegration

Experimental.

type LambdaWebSocketIntegrationProps 

type LambdaWebSocketIntegrationProps struct {
	// The handler for this integration.
	// Experimental.
	Handler awslambda.IFunction `json:"handler"`
}

Lambda WebSocket Integration props.

TODO: EXAMPLE

Experimental.

Source Files

View all Source files

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.