@aws-cdk_aws-apigatewayv2-alpha.PayloadFormatVersion

class PayloadFormatVersion ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.PayloadFormatVersion
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#PayloadFormatVersion
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.PayloadFormatVersion
Pythonaws_cdk.aws_apigatewayv2_alpha.PayloadFormatVersion
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป 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_alpha from '@aws-cdk/aws-apigatewayv2-alpha';
const payloadFormatVersion = apigatewayv2_alpha.PayloadFormatVersion.custom('version');

Properties

NameTypeDescription
version๐Ÿ”นstringversion as a string.
static VERSION_1_0๐Ÿ”นPayloadFormatVersionVersion 1.0.
static VERSION_2_0๐Ÿ”นPayloadFormatVersionVersion 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

NameDescription
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