Class: AWSCDK::APIGatewayv2Integrations::HttpALBIntegrationProps

Inherits:
HttpPrivateIntegrationOptions
  • Object
show all
Defined in:
api_gatewayv2_integrations/http_alb_integration_props.rb

Overview

Properties to initialize HttpAlbIntegration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method: nil, parameter_mapping: nil, secure_server_name: nil, timeout: nil, vpc_link: nil) ⇒ HttpALBIntegrationProps

Returns a new instance of HttpALBIntegrationProps.

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.

  • secure_server_name (String, nil) (defaults to: nil) —

    Specifies the server name to verified by HTTPS when calling the backend integration.

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

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

  • vpc_link (AWSCDK::APIGatewayv2::IVPCLink, nil) (defaults to: nil) —

    The vpc link to be used for the private integration.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'api_gatewayv2_integrations/http_alb_integration_props.rb', line 12

def initialize(method: nil, parameter_mapping: nil, secure_server_name: nil, timeout: nil, vpc_link: 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?
  @secure_server_name = secure_server_name
  Jsii::Type.check_type(@secure_server_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secureServerName") unless @secure_server_name.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
  @vpc_link = vpc_link
  Jsii::Type.check_type(@vpc_link, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLklWcGNMaW5rIn0=")), "vpcLink") unless @vpc_link.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:



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

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:



35
36
37
 
# File 'api_gatewayv2_integrations/http_alb_integration_props.rb', line 35

def parameter_mapping
  @parameter_mapping
end

#secure_server_name ⇒ String? (readonly)

Note:

Default: undefined private integration traffic will use HTTP protocol

Specifies the server name to verified by HTTPS when calling the backend integration.

Returns:

  • (String, nil)

See Also:



41
42
43
 
# File 'api_gatewayv2_integrations/http_alb_integration_props.rb', line 41

def secure_server_name
  @secure_server_name
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:



48
49
50
 
# File 'api_gatewayv2_integrations/http_alb_integration_props.rb', line 48

def timeout
  @timeout
end

#vpc_link ⇒ AWSCDK::APIGatewayv2::IVPCLink? (readonly)

Note:

Default: - a new VpcLink is created

The vpc link to be used for the private integration.

Returns:



53
54
55
 
# File 'api_gatewayv2_integrations/http_alb_integration_props.rb', line 53

def vpc_link
  @vpc_link
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'api_gatewayv2_integrations/http_alb_integration_props.rb', line 55

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

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'api_gatewayv2_integrations/http_alb_integration_props.rb', line 65

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