Module: AWSCDK::APIGatewayv2::IWebSocketAPI

Includes:
IAPI, IWebSocketAPIRef
Included in:
WebSocketAPI
Defined in:
api_gatewayv2/i_web_socket_api.rb

Overview

Represents a WebSocket API.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 113

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :api_ref => { kind: :property, name: "apiRef", is_optional: false },
    :api_endpoint => { kind: :property, name: "apiEndpoint", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :is_websocket_api => { kind: :property, name: "isWebsocketApi", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
  }
end

Instance Method Details

#api_endpoint ⇒ String

The default endpoint for an API.

Returns:

  • (String) 


48
49
50
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 48

def api_endpoint()
  jsii_get_property("apiEndpoint")
end

#api_id ⇒ String

The identifier of this API Gateway API.

Returns:

  • (String) 


55
56
57
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 55

def api_id()
  jsii_get_property("apiId")
end

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

A reference to a Api resource.

Returns:



41
42
43
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 41

def api_ref()
  jsii_get_property("apiRef")
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



95
96
97
98
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 95

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



27
28
29
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 27

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) 


65
66
67
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 65

def is_websocket_api()
  jsii_get_property("isWebsocketApi")
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - average over 5 minutes

Return the given named metric for this Api Gateway.

Parameters:

Returns:



106
107
108
109
110
111
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 106

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

def stack()
  jsii_get_property("stack")
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



76
77
78
79
80
81
 
# File 'api_gatewayv2/i_web_socket_api.rb', line 76

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