Class: AWSCDK::APIGatewayv2::ParameterMapping

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

Overview

Represents a Parameter Mapping.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ParameterMapping

Returns a new instance of ParameterMapping.



8
9
10
 
# File 'api_gatewayv2/parameter_mapping.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.from_object(obj) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping from an object.

Parameters:

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


30
31
32
33
 
# File 'api_gatewayv2/parameter_mapping.rb', line 30

def self.from_object(obj)
  Jsii::Type.check_type(obj, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5djIuTWFwcGluZ1ZhbHVlIn0sImtpbmQiOiJtYXAifX0=")), "obj")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.ParameterMapping", "fromObject", [obj])
end

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :mappings => { kind: :property, name: "mappings", is_optional: false },
    :append_header => { kind: :method, name: "appendHeader", is_optional: false },
    :append_query_string => { kind: :method, name: "appendQueryString", is_optional: false },
    :custom => { kind: :method, name: "custom", is_optional: false },
    :overwrite_header => { kind: :method, name: "overwriteHeader", is_optional: false },
    :overwrite_path => { kind: :method, name: "overwritePath", is_optional: false },
    :overwrite_query_string => { kind: :method, name: "overwriteQueryString", is_optional: false },
    :remove_header => { kind: :method, name: "removeHeader", is_optional: false },
    :remove_query_string => { kind: :method, name: "removeQueryString", is_optional: false },
  }
end

Instance Method Details

#append_header(name, value) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping to append a header.

Parameters:

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


47
48
49
50
51
 
# File 'api_gatewayv2/parameter_mapping.rb', line 47

def append_header(name, value)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLk1hcHBpbmdWYWx1ZSJ9")), "value")
  jsii_call_method("appendHeader", [name, value])
end

#append_query_string(name, value) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping to append a query string.

Parameters:

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


58
59
60
61
62
 
# File 'api_gatewayv2/parameter_mapping.rb', line 58

def append_query_string(name, value)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLk1hcHBpbmdWYWx1ZSJ9")), "value")
  jsii_call_method("appendQueryString", [name, value])
end

#custom(key, value) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a custom mapping.

Parameters:

  • key (String)
  • value (String)

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


69
70
71
72
73
 
# File 'api_gatewayv2/parameter_mapping.rb', line 69

def custom(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  jsii_call_method("custom", [key, value])
end

#mappings ⇒ Hash{String => String}

Represents all created parameter mappings.

Returns:

  • (Hash{String => String}) 


38
39
40
 
# File 'api_gatewayv2/parameter_mapping.rb', line 38

def mappings()
  jsii_get_property("mappings")
end

#overwrite_header(name, value) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping to overwrite a header.

Parameters:

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


80
81
82
83
84
 
# File 'api_gatewayv2/parameter_mapping.rb', line 80

def overwrite_header(name, value)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLk1hcHBpbmdWYWx1ZSJ9")), "value")
  jsii_call_method("overwriteHeader", [name, value])
end

#overwrite_path(value) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping to overwrite a path.

Parameters:

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


90
91
92
93
 
# File 'api_gatewayv2/parameter_mapping.rb', line 90

def overwrite_path(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLk1hcHBpbmdWYWx1ZSJ9")), "value")
  jsii_call_method("overwritePath", [value])
end

#overwrite_query_string(name, value) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping to overwrite a querystring.

Parameters:

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


100
101
102
103
104
 
# File 'api_gatewayv2/parameter_mapping.rb', line 100

def overwrite_query_string(name, value)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLk1hcHBpbmdWYWx1ZSJ9")), "value")
  jsii_call_method("overwriteQueryString", [name, value])
end

#remove_header(name) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping to remove a header.

Parameters:

  • name (String)

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


110
111
112
113
 
# File 'api_gatewayv2/parameter_mapping.rb', line 110

def remove_header(name)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_call_method("removeHeader", [name])
end

#remove_query_string(name) ⇒ AWSCDK::APIGatewayv2::ParameterMapping

Creates a mapping to remove a querystring.

Parameters:

  • name (String)

Returns:

  • (AWSCDK::APIGatewayv2::ParameterMapping) 


119
120
121
122
 
# File 'api_gatewayv2/parameter_mapping.rb', line 119

def remove_query_string(name)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_call_method("removeQueryString", [name])
end