Package 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.121.0 (build d7af9b9)", date="2025-12-18T18:20:04.404Z") @Stability(Stable) public class PayloadFormatVersion extends software.amazon.jsii.JsiiObject
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:

  • 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
    Description
    static final PayloadFormatVersion
    VERSION_1_0
    Version 1.0.
    static final PayloadFormatVersion
    VERSION_2_0
    Version 2.0.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static PayloadFormatVersion
    custom(String version)
    A custom payload version.
    String
    getVersion()
    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 Details

  • Constructor Details

    • PayloadFormatVersion

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

    • PayloadFormatVersion

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

  • Method Details

    • custom

      @Stability(Stable) @NotNull public static PayloadFormatVersion custom(@NotNull String version)
      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(Stable) @NotNull public String getVersion()
      version as a string.