Class: AWSCDK::APIGatewayv2::CfnRouteResponseProps

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

Overview

Properties for defining a CfnRouteResponse.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_id:, route_id:, route_response_key:, model_selection_expression: nil, response_models: nil, response_parameters: nil) ⇒ CfnRouteResponseProps

Returns a new instance of CfnRouteResponseProps.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 15

def initialize(api_id:, route_id:, route_response_key:, model_selection_expression: nil, response_models: nil, response_parameters: nil)
  @api_id = api_id
  Jsii::Type.check_type(@api_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5djIuSUFwaVJlZiJ9XX19")), "apiId")
  @route_id = route_id
  Jsii::Type.check_type(@route_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5djIuSVJvdXRlUmVmIn1dfX0=")), "routeId")
  @route_response_key = route_response_key
  Jsii::Type.check_type(@route_response_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "routeResponseKey")
  @model_selection_expression = model_selection_expression
  Jsii::Type.check_type(@model_selection_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelSelectionExpression") unless @model_selection_expression.nil?
  @response_models = response_models
  Jsii::Type.check_type(@response_models, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "responseModels") unless @response_models.nil?
  @response_parameters = response_parameters
  Jsii::Type.check_type(@response_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkNmblJvdXRlUmVzcG9uc2UuUGFyYW1ldGVyQ29uc3RyYWludHNQcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "responseParameters") unless @response_parameters.nil?
end

Instance Attribute Details

#api_id ⇒ String, AWSCDK::Interfaces::AWSApigatewayv2::IAPIRef (readonly)

The API identifier.

Returns:

See Also:



34
35
36
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 34

def api_id
  @api_id
end

#model_selection_expression ⇒ String? (readonly)

The model selection expression for the route response.

Supported only for WebSocket APIs.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 51

def model_selection_expression
  @model_selection_expression
end

#response_models ⇒ Object? (readonly)

The response models for the route response.

Returns:

  • (Object, nil)

See Also:



56
57
58
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 56

def response_models
  @response_models
end

#response_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The route response parameters.

Returns:

See Also:



61
62
63
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 61

def response_parameters
  @response_parameters
end

#route_id ⇒ String, AWSCDK::Interfaces::AWSApigatewayv2::IRouteRef (readonly)

The route ID.

Returns:

See Also:



39
40
41
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 39

def route_id
  @route_id
end

#route_response_key ⇒ String (readonly)

The route response key.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 44

def route_response_key
  @route_response_key
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 63

def self.jsii_properties
  {
    :api_id => "apiId",
    :route_id => "routeId",
    :route_response_key => "routeResponseKey",
    :model_selection_expression => "modelSelectionExpression",
    :response_models => "responseModels",
    :response_parameters => "responseParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'api_gatewayv2/cfn_route_response_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "apiId" => @api_id,
    "routeId" => @route_id,
    "routeResponseKey" => @route_response_key,
    "modelSelectionExpression" => @model_selection_expression,
    "responseModels" => @response_models,
    "responseParameters" => @response_parameters,
  })
  result.compact
end