software.amazon.awscdk.services.apigatewayv2

Class PayloadFormatVersion

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.PayloadFormatVersion

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.864Z")
 @Stability(value=Experimental)
public class PayloadFormatVersion
extends software.amazon.jsii.JsiiObject

(experimental) Payload format version for lambda proxy integration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 PayloadFormatVersion payloadFormatVersion = PayloadFormatVersion.custom("version");
 

See Also:

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static PayloadFormatVersion	VERSION_1_0 (experimental) Version 1.0.
static PayloadFormatVersion	VERSION_2_0 (experimental) Version 2.0.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PayloadFormatVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PayloadFormatVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static PayloadFormatVersion	custom(String version) (experimental) A custom payload version.
String	getVersion() (experimental) version as a string.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

VERSION_1_0

@Stability(value=Experimental)
public static final PayloadFormatVersion VERSION_1_0

(experimental) Version 1.0.

VERSION_2_0

@Stability(value=Experimental)
public static final PayloadFormatVersion VERSION_2_0

(experimental) Version 2.0.

Constructor Detail

PayloadFormatVersion

protected PayloadFormatVersion(software.amazon.jsii.JsiiObjectRef objRef)

PayloadFormatVersion

protected PayloadFormatVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

custom

@Stability(value=Experimental)
 @NotNull
public static PayloadFormatVersion custom(@NotNull
                                                                                   String version)

(experimental) A custom payload version.

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

Parameters:

version - This parameter is required.

getVersion

@Stability(value=Experimental)
 @NotNull
public String getVersion()

(experimental) version as a string.