aws-cdk-lib.aws_apigatewayv2.PayloadFormatVersion

PayloadFormatVersion Class

Payload format version for lambda proxy integration.

Source

aws-apigatewayv2/lib/http/integration.ts

Type last changed

v2.112.0 · 1 Dec 2023

Example

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

Properties

versionstringversionstrversionStringVersionstringVersion*string#

version as a string.

VERSION_1_0PayloadFormatVersionversion_1_0PayloadFormatVersionVERSION_1_0PayloadFormatVersionVERSION_1_0PayloadFormatVersionVERSION_1_0PayloadFormatVersionstatic#

Version 1.0.

VERSION_2_0PayloadFormatVersionversion_2_0PayloadFormatVersionVERSION_2_0PayloadFormatVersionVERSION_2_0PayloadFormatVersionVERSION_2_0PayloadFormatVersionstatic#

Version 2.0.

Methods

custom(version: string): PayloadFormatVersion // chainable@staticmethod def custom(version: str) -> PayloadFormatVersionpublic static PayloadFormatVersion custom(String version)public static PayloadFormatVersion Custom(string version)func Custom(Version *string) PayloadFormatVersionstatic#

A custom payload version.

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