Class: AWSCDK::APIGatewayv2::WebSocketAPI

Inherits:
Resource
  • Object
show all
Includes:
IAPI, IWebSocketAPI
Defined in:
api_gatewayv2/web_socket_api.rb

Overview

Create a new API Gateway WebSocket API endpoint.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ WebSocketAPI

Returns a new instance of WebSocketAPI.

Parameters:



13
14
15
16
17
18
19
 
# File 'api_gatewayv2/web_socket_api.rb', line 13

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::WebSocketAPIProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLldlYlNvY2tldEFwaVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_web_socket_api_attributes(scope, id, attrs) ⇒ AWSCDK::APIGatewayv2::IWebSocketAPI

Import an existing WebSocket API into this CDK app.

Parameters:

Returns:



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

def self.from_web_socket_api_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::WebSocketAPIAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLldlYlNvY2tldEFwaUF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.WebSocketApi", "fromWebSocketApiAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'api_gatewayv2/web_socket_api.rb', line 21

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :api_endpoint => { kind: :property, name: "apiEndpoint", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :api_ref => { kind: :property, name: "apiRef", is_optional: false },
    :is_websocket_api => { kind: :property, name: "isWebsocketApi", is_optional: false },
    :web_socket_api_name => { kind: :property, name: "webSocketApiName", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_route => { kind: :method, name: "addRoute", is_optional: false },
    :arn_for_execute_api => { kind: :method, name: "arnForExecuteApi", is_optional: false },
    :arn_for_execute_api_v2 => { kind: :method, name: "arnForExecuteApiV2", is_optional: false },
    :grant_manage_connections => { kind: :method, name: "grantManageConnections", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


107
108
109
 
# File 'api_gatewayv2/web_socket_api.rb', line 107

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigatewayv2.WebSocketApi", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_route(route_key, options) ⇒ AWSCDK::APIGatewayv2::WebSocketRoute

Add a new route.

Parameters:

Returns:



246
247
248
249
250
251
 
# File 'api_gatewayv2/web_socket_api.rb', line 246

def add_route(route_key, options)
  Jsii::Type.check_type(route_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "routeKey")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::WebSocketRouteOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLldlYlNvY2tldFJvdXRlT3B0aW9ucyJ9")), "options")
  jsii_call_method("addRoute", [route_key, options])
end

#api_endpoint ⇒ String

The default endpoint for an API.

Returns:

  • (String) 


114
115
116
 
# File 'api_gatewayv2/web_socket_api.rb', line 114

def api_endpoint()
  jsii_get_property("apiEndpoint")
end

#api_id ⇒ String

The identifier of this API Gateway API.

Returns:

  • (String) 


121
122
123
 
# File 'api_gatewayv2/web_socket_api.rb', line 121

def api_id()
  jsii_get_property("apiId")
end

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

A reference to a Api resource.

Returns:



128
129
130
 
# File 'api_gatewayv2/web_socket_api.rb', line 128

def api_ref()
  jsii_get_property("apiRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



184
185
186
187
 
# File 'api_gatewayv2/web_socket_api.rb', line 184

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
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:



201
202
203
204
 
# File 'api_gatewayv2/web_socket_api.rb', line 201

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#arn_for_execute_api(method = nil, path = nil, stage = nil) ⇒ String

Deprecated.

Use arnForExecuteApiV2() instead.

Get the "execute-api" ARN.

Parameters:

  • method (String, nil) (defaults to: nil)
  • path (String, nil) (defaults to: nil)
  • stage (String, nil) (defaults to: nil)

Returns:

  • (String) 


260
261
262
263
264
265
 
# File 'api_gatewayv2/web_socket_api.rb', line 260

def arn_for_execute_api(method = nil, path = nil, stage = nil)
  Jsii::Type.check_type(method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "method") unless method.nil?
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless path.nil?
  Jsii::Type.check_type(stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage") unless stage.nil?
  jsii_call_method("arnForExecuteApi", [method, path, stage])
end

#arn_for_execute_api_v2(route = nil, stage = nil) ⇒ String

Note:

Default: - The default behavior applies when no specific route, or stage is provided. In this case, the ARN will cover all routes, and all stages of this API. Specifically, if 'route' is not specified, it defaults to '', representing all routes. If 'stage' is not specified, it also defaults to '', representing all stages.

Get the "execute-api" ARN.

Parameters:

  • route (String, nil) (defaults to: nil)
  • stage (String, nil) (defaults to: nil)

Returns:

  • (String) 


273
274
275
276
277
 
# File 'api_gatewayv2/web_socket_api.rb', line 273

def arn_for_execute_api_v2(route = nil, stage = nil)
  Jsii::Type.check_type(route, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "route") unless route.nil?
  Jsii::Type.check_type(stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage") unless stage.nil?
  jsii_call_method("arnForExecuteApiV2", [route, stage])
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:



79
80
81
 
# File 'api_gatewayv2/web_socket_api.rb', line 79

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


207
208
209
 
# File 'api_gatewayv2/web_socket_api.rb', line 207

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


221
222
223
224
225
226
 
# File 'api_gatewayv2/web_socket_api.rb', line 221

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


236
237
238
239
 
# File 'api_gatewayv2/web_socket_api.rb', line 236

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant_manage_connections(identity) ⇒ AWSCDK::IAM::Grant

Grant access to the API Gateway management API for this WebSocket API to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

Parameters:

Returns:



285
286
287
288
 
# File 'api_gatewayv2/web_socket_api.rb', line 285

def grant_manage_connections(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantManageConnections", [identity])
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) 


138
139
140
 
# File 'api_gatewayv2/web_socket_api.rb', line 138

def is_websocket_api()
  jsii_get_property("isWebsocketApi")
end

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

Return the given named metric for this Api Gateway.

Parameters:

Returns:



295
296
297
298
299
300
 
# File 'api_gatewayv2/web_socket_api.rb', line 295

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) 


64
65
66
 
# File 'api_gatewayv2/web_socket_api.rb', line 64

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


93
94
95
 
# File 'api_gatewayv2/web_socket_api.rb', line 93

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



100
101
102
 
# File 'api_gatewayv2/web_socket_api.rb', line 100

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


154
155
156
 
# File 'api_gatewayv2/web_socket_api.rb', line 154

def to_string()
  jsii_call_method("toString", [])
end

#web_socket_api_name ⇒ String?

A human friendly name for this WebSocket API.

Note that this is different from web_socket_api_id.

Returns:

  • (String, nil) 


147
148
149
 
# File 'api_gatewayv2/web_socket_api.rb', line 147

def web_socket_api_name()
  jsii_get_property("webSocketApiName")
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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


167
168
169
170
171
172
 
# File 'api_gatewayv2/web_socket_api.rb', line 167

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