Class: AWSCDK::APIGatewayv2::PayloadFormatVersion

Inherits:
Jsii::Object
  • Object
show all
Defined in:
api_gatewayv2/payload_format_version.rb

Overview

Payload format version for lambda proxy integration.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ PayloadFormatVersion

Returns a new instance of PayloadFormatVersion.

Raises:

  • (NoMethodError) 


10
11
12
 
# File 'api_gatewayv2/payload_format_version.rb', line 10

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_apigatewayv2.PayloadFormatVersion does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.custom(version) ⇒ AWSCDK::APIGatewayv2::PayloadFormatVersion

A custom payload version.

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

Parameters:

  • version (String)

Returns:

  • (AWSCDK::APIGatewayv2::PayloadFormatVersion) 


26
27
28
29
 
# File 'api_gatewayv2/payload_format_version.rb', line 26

def self.custom(version)
  Jsii::Type.check_type(version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.PayloadFormatVersion", "custom", [version])
end

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
 
# File 'api_gatewayv2/payload_format_version.rb', line 14

def self.jsii_overridable_methods
  {
    :version => { kind: :property, name: "version", is_optional: false },
  }
end

.VERSION_1_0 ⇒ AWSCDK::APIGatewayv2::PayloadFormatVersion

Version 1.0.

Returns:

  • (AWSCDK::APIGatewayv2::PayloadFormatVersion) 


34
35
36
 
# File 'api_gatewayv2/payload_format_version.rb', line 34

def self.VERSION_1_0()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigatewayv2.PayloadFormatVersion", "VERSION_1_0")
end

.VERSION_2_0 ⇒ AWSCDK::APIGatewayv2::PayloadFormatVersion

Version 2.0.

Returns:

  • (AWSCDK::APIGatewayv2::PayloadFormatVersion) 


41
42
43
 
# File 'api_gatewayv2/payload_format_version.rb', line 41

def self.VERSION_2_0()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigatewayv2.PayloadFormatVersion", "VERSION_2_0")
end

Instance Method Details

#version ⇒ String

version as a string.

Returns:

  • (String) 


48
49
50
 
# File 'api_gatewayv2/payload_format_version.rb', line 48

def version()
  jsii_get_property("version")
end