Class: AWSCDK::APIGatewayv2::UsagePlanPerAPIStage

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

Overview

Represents the API stages that a usage plan applies to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api: nil, stage: nil) ⇒ UsagePlanPerAPIStage

Returns a new instance of UsagePlanPerAPIStage.

Parameters:



9
10
11
12
13
14
 
# File 'api_gatewayv2/usage_plan_per_api_stage.rb', line 9

def initialize(api: nil, stage: nil)
  @api = api
  Jsii::Type.check_type(@api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLklXZWJTb2NrZXRBcGkifQ==")), "api") unless @api.nil?
  @stage = stage
  Jsii::Type.check_type(@stage, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLklXZWJTb2NrZXRTdGFnZSJ9")), "stage") unless @stage.nil?
end

Instance Attribute Details

#api ⇒ AWSCDK::APIGatewayv2::IWebSocketAPI? (readonly)

Note:

Default: none

The WebSocket API to associate with the usage plan.

Returns:



20
21
22
 
# File 'api_gatewayv2/usage_plan_per_api_stage.rb', line 20

def api
  @api
end

#stage ⇒ AWSCDK::APIGatewayv2::IWebSocketStage? (readonly)

Note:

Default: none

[disable-awslint:ref-via-interface].

Returns:



25
26
27
 
# File 'api_gatewayv2/usage_plan_per_api_stage.rb', line 25

def stage
  @stage
end

Class Method Details

.jsii_properties ⇒ Object 



27
28
29
30
31
32
 
# File 'api_gatewayv2/usage_plan_per_api_stage.rb', line 27

def self.jsii_properties
  {
    :api => "api",
    :stage => "stage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'api_gatewayv2/usage_plan_per_api_stage.rb', line 34

def to_jsii
  result = {}
  result.merge!({
    "api" => @api,
    "stage" => @stage,
  })
  result.compact
end