Class: AWSCDK::APIGatewayv2::HttpRouteIntegrationConfig

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

Overview

Config returned back as a result of the bind.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payload_format_version:, type:, connection_id: nil, connection_type: nil, credentials: nil, method: nil, parameter_mapping: nil, secure_server_name: nil, subtype: nil, timeout: nil, uri: nil) ⇒ HttpRouteIntegrationConfig

Returns a new instance of HttpRouteIntegrationConfig.

Parameters:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 18

def initialize(payload_format_version:, type:, connection_id: nil, connection_type: nil, credentials: nil, method: nil, parameter_mapping: nil, secure_server_name: nil, subtype: nil, timeout: nil, uri: nil)
  @payload_format_version = payload_format_version
  Jsii::Type.check_type(@payload_format_version, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLlBheWxvYWRGb3JtYXRWZXJzaW9uIn0=")), "payloadFormatVersion")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBJbnRlZ3JhdGlvblR5cGUifQ==")), "type")
  @connection_id = connection_id
  Jsii::Type.check_type(@connection_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionId") unless @connection_id.nil?
  @connection_type = connection_type
  Jsii::Type.check_type(@connection_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBDb25uZWN0aW9uVHlwZSJ9")), "connectionType") unless @connection_type.nil?
  @credentials = credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkludGVncmF0aW9uQ3JlZGVudGlhbHMifQ==")), "credentials") unless @credentials.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?
  @subtype = subtype
  Jsii::Type.check_type(@subtype, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBJbnRlZ3JhdGlvblN1YnR5cGUifQ==")), "subtype") unless @subtype.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
  @uri = uri
  Jsii::Type.check_type(@uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "uri") unless @uri.nil?
end

Instance Attribute Details

#connection_id ⇒ String? (readonly)

Note:

Default: - undefined

The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

Returns:

  • (String, nil) 


59
60
61
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 59

def connection_id
  @connection_id
end

#connection_type ⇒ AWSCDK::APIGatewayv2::HttpConnectionType? (readonly)

Note:

Default: HttpConnectionType.INTERNET

The type of the network connection to the integration endpoint.

Returns:



64
65
66
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 64

def connection_type
  @connection_type
end

#credentials ⇒ AWSCDK::APIGatewayv2::IntegrationCredentials? (readonly)

Note:

Default: - no credentials, use resource-based permissions on supported AWS services

The credentials with which to invoke the integration.

Returns:



69
70
71
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 69

def credentials
  @credentials
end

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

Note:

Default: - undefined

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

Required for HttpIntegrationType.HTTP_PROXY

Returns:



76
77
78
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 76

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:



82
83
84
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 82

def parameter_mapping
  @parameter_mapping
end

#payload_format_version ⇒ AWSCDK::APIGatewayv2::PayloadFormatVersion (readonly)

Note:

Default: - undefined

Payload format version in the case of lambda proxy integration.

Returns:

See Also:



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

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



88
89
90
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 88

def secure_server_name
  @secure_server_name
end

#subtype ⇒ AWSCDK::APIGatewayv2::HttpIntegrationSubtype? (readonly)

Note:

Default: - none, required if no integrationUri is defined.

Integration subtype.

Returns:



93
94
95
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 93

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



100
101
102
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 100

def timeout
  @timeout
end

#type ⇒ AWSCDK::APIGatewayv2::HttpIntegrationType (readonly)

Integration type.

Returns:



52
53
54
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 52

def type
  @type
end

#uri ⇒ String? (readonly)

Note:

Default: - none, required if no integrationSubtype is defined.

Integration URI.

Returns:

  • (String, nil) 


105
106
107
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 105

def uri
  @uri
end

Class Method Details

.jsii_properties ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 107

def self.jsii_properties
  {
    :payload_format_version => "payloadFormatVersion",
    :type => "type",
    :connection_id => "connectionId",
    :connection_type => "connectionType",
    :credentials => "credentials",
    :method => "method",
    :parameter_mapping => "parameterMapping",
    :secure_server_name => "secureServerName",
    :subtype => "subtype",
    :timeout => "timeout",
    :uri => "uri",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'api_gatewayv2/http_route_integration_config.rb', line 123

def to_jsii
  result = {}
  result.merge!({
    "payloadFormatVersion" => @payload_format_version,
    "type" => @type,
    "connectionId" => @connection_id,
    "connectionType" => @connection_type,
    "credentials" => @credentials,
    "method" => @method,
    "parameterMapping" => @parameter_mapping,
    "secureServerName" => @secure_server_name,
    "subtype" => @subtype,
    "timeout" => @timeout,
    "uri" => @uri,
  })
  result.compact
end