Class: AWSCDK::APIGateway::HttpIntegrationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/http_integration_props.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http_method: nil, options: nil, proxy: nil) ⇒ HttpIntegrationProps

Returns a new instance of HttpIntegrationProps.

Parameters:

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

    HTTP method to use when invoking the backend URL.

  • options (AWSCDK::APIGateway::IntegrationOptions, nil) (defaults to: nil) —

    Integration options, such as request/resopnse mapping, content handling, etc.

  • proxy (Boolean, nil) (defaults to: nil) —

    Determines whether to use proxy integration or custom integration.



9
10
11
12
13
14
15
16
 
# File 'api_gateway/http_integration_props.rb', line 9

def initialize(http_method: nil, options: nil, proxy: nil)
  @http_method = http_method
  Jsii::Type.check_type(@http_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "httpMethod") unless @http_method.nil?
  @options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::IntegrationOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(@options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5JbnRlZ3JhdGlvbk9wdGlvbnMifQ==")), "options") unless @options.nil?
  @proxy = proxy
  Jsii::Type.check_type(@proxy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "proxy") unless @proxy.nil?
end

Instance Attribute Details

#http_method ⇒ String? (readonly)

Note:

Default: GET

HTTP method to use when invoking the backend URL.

Returns:

  • (String, nil) 


22
23
24
 
# File 'api_gateway/http_integration_props.rb', line 22

def http_method
  @http_method
end

#options ⇒ AWSCDK::APIGateway::IntegrationOptions? (readonly)

Note:

Default: defaults based on IntegrationOptions defaults

Integration options, such as request/resopnse mapping, content handling, etc.

Returns:



27
28
29
 
# File 'api_gateway/http_integration_props.rb', line 27

def options
  @options
end

#proxy ⇒ Boolean? (readonly)

Note:

Default: true

Determines whether to use proxy integration or custom integration.

Returns:

  • (Boolean, nil) 


32
33
34
 
# File 'api_gateway/http_integration_props.rb', line 32

def proxy
  @proxy
end

Class Method Details

.jsii_properties ⇒ Object 



34
35
36
37
38
39
40
 
# File 'api_gateway/http_integration_props.rb', line 34

def self.jsii_properties
  {
    :http_method => "httpMethod",
    :options => "options",
    :proxy => "proxy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'api_gateway/http_integration_props.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "httpMethod" => @http_method,
    "options" => @options,
    "proxy" => @proxy,
  })
  result.compact
end