Class: AWSCDK::APIGatewayv2Integrations::HttpURLIntegrationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2_integrations/http_url_integration_props.rb

Overview

Properties to initialize a new HttpProxyIntegration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method: nil, parameter_mapping: nil, timeout: nil) ⇒ HttpURLIntegrationProps

Returns a new instance of HttpURLIntegrationProps.

Parameters:

  • method (AWSCDK::APIGatewayv2::HttpMethod, nil) (defaults to: nil) —

    The HTTP method that must be used to invoke the underlying HTTP proxy.

  • parameter_mapping (AWSCDK::APIGatewayv2::ParameterMapping, nil) (defaults to: nil) —

    Specifies how to transform HTTP requests before sending them to the backend.

  • timeout (AWSCDK::Duration, nil) (defaults to: nil) —

    The maximum amount of time an integration will run before it returns without a response.



10
11
12
13
14
15
16
17
 
# File 'api_gatewayv2_integrations/http_url_integration_props.rb', line 10

def initialize(method: nil, parameter_mapping: nil, timeout: nil)
  @method = method
  Jsii::Type.check_type(@method, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBNZXRob2QifQ==")), "method") unless @method.nil?
  @parameter_mapping = parameter_mapping
  Jsii::Type.check_type(@parameter_mapping, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLlBhcmFtZXRlck1hcHBpbmcifQ==")), "parameterMapping") unless @parameter_mapping.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
end

Instance Attribute Details

#method ⇒ AWSCDK::APIGatewayv2::HttpMethod? (readonly)

Note:

Default: HttpMethod.ANY

The HTTP method that must be used to invoke the underlying HTTP proxy.

Returns:



23
24
25
 
# File 'api_gatewayv2_integrations/http_url_integration_props.rb', line 23

def method
  @method
end

#parameter_mapping ⇒ AWSCDK::APIGatewayv2::ParameterMapping? (readonly)

Note:

Default: undefined requests are sent to the backend unmodified

Specifies how to transform HTTP requests before sending them to the backend.

Returns:

See Also:



29
30
31
 
# File 'api_gatewayv2_integrations/http_url_integration_props.rb', line 29

def parameter_mapping
  @parameter_mapping
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Duration.seconds(29)

The maximum amount of time an integration will run before it returns without a response.

Must be between 50 milliseconds and 29 seconds.

Returns:



36
37
38
 
# File 'api_gatewayv2_integrations/http_url_integration_props.rb', line 36

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



38
39
40
41
42
43
44
 
# File 'api_gatewayv2_integrations/http_url_integration_props.rb', line 38

def self.jsii_properties
  {
    :method => "method",
    :parameter_mapping => "parameterMapping",
    :timeout => "timeout",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



46
47
48
49
50
51
52
53
54
 
# File 'api_gatewayv2_integrations/http_url_integration_props.rb', line 46

def to_jsii
  result = {}
  result.merge!({
    "method" => @method,
    "parameterMapping" => @parameter_mapping,
    "timeout" => @timeout,
  })
  result.compact
end