Module: AWSCDK::APIGatewayv2::IWebSocketAPIRef

Includes:
Interfaces::AWSApigatewayv2::IAPIRef
Included in:
IWebSocketAPI
Defined in:
api_gatewayv2/i_web_socket_api_ref.rb

Overview

Represents a reference to an HTTP API.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



61
62
63
64
65
66
67
68
69
 
# File 'api_gatewayv2/i_web_socket_api_ref.rb', line 61

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :api_ref => { kind: :property, name: "apiRef", is_optional: false },
    :is_websocket_api => { kind: :property, name: "isWebsocketApi", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
  }
end

Instance Method Details

#api_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::APIReference

A reference to a Api resource.

Returns:



33
34
35
 
# File 'api_gatewayv2/i_web_socket_api_ref.rb', line 33

def api_ref()
  jsii_get_property("apiRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



26
27
28
 
# File 'api_gatewayv2/i_web_socket_api_ref.rb', line 26

def env()
  jsii_get_property("env")
end

#is_websocket_api ⇒ Boolean

Indicates that this is a WebSocket API.

Will always return true, but is necessary to prevent accidental structural equality in TypeScript.

Returns:

  • (Boolean) 


43
44
45
 
# File 'api_gatewayv2/i_web_socket_api_ref.rb', line 43

def is_websocket_api()
  jsii_get_property("isWebsocketApi")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'api_gatewayv2/i_web_socket_api_ref.rb', line 11

def node()
  jsii_get_property("node")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



54
55
56
57
58
59
 
# File 'api_gatewayv2/i_web_socket_api_ref.rb', line 54

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end