class PayloadFormatVersion 🔹

Language	Type name
.NET	Amazon.CDK.AWS.APIGatewayv2.PayloadFormatVersion
Java	software.amazon.awscdk.services.apigatewayv2.PayloadFormatVersion
Python	aws_cdk.aws_apigatewayv2.PayloadFormatVersion
TypeScript (source)	@aws-cdk/aws-apigatewayv2 » PayloadFormatVersion

Payload format version for lambda proxy integration.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
const payloadFormatVersion = apigatewayv2.PayloadFormatVersion.custom('version');

Properties

Name	Type	Description
version🔹	string	version as a string.
static VERSION_1_0🔹	PayloadFormatVersion	Version 1.0.
static VERSION_2_0🔹	PayloadFormatVersion	Version 2.0.

---

version🔹

Type: string

version as a string.

---

static VERSION_1_0🔹

Type: PayloadFormatVersion

Version 1.0.

---

static VERSION_2_0🔹

Type: PayloadFormatVersion

Version 2.0.

Methods

Name	Description
static custom(version)🔹	A custom payload version.

---

static custom(version)🔹

public static custom(version: string): PayloadFormatVersion

Parameters

• version string

Returns

• PayloadFormatVersion

A custom payload version.

Typically used if there is a version number that the CDK doesn't support yet