Class: AWSCDK::APIGatewayv2::WebSocketStageAttributes

Inherits:
StageAttributes
  • Object
show all
Defined in:
api_gatewayv2/web_socket_stage_attributes.rb

Overview

The attributes used to import existing WebSocketStage.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stage_name:, api:) ⇒ WebSocketStageAttributes

Returns a new instance of WebSocketStageAttributes.

Parameters:



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

def initialize(stage_name:, api:)
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName")
  @api = api
  Jsii::Type.check_type(@api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLklXZWJTb2NrZXRBcGkifQ==")), "api")
end

Instance Attribute Details

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

The API to which this stage is associated.

Returns:



23
24
25
 
# File 'api_gatewayv2/web_socket_stage_attributes.rb', line 23

def api
  @api
end

#stage_name ⇒ String (readonly)

The name of the stage.

Returns:

  • (String) 


19
20
21
 
# File 'api_gatewayv2/web_socket_stage_attributes.rb', line 19

def stage_name
  @stage_name
end

Class Method Details

.jsii_properties ⇒ Object 



25
26
27
28
29
30
 
# File 'api_gatewayv2/web_socket_stage_attributes.rb', line 25

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

Instance Method Details

#to_jsii ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'api_gatewayv2/web_socket_stage_attributes.rb', line 32

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