Class: AWSCDK::APIGatewayv2::WebSocketStage

Inherits:
Resource
  • Object
show all
Includes:
IStage, IWebSocketStage
Defined in:
api_gatewayv2/web_socket_stage.rb

Overview

Represents a stage where an instance of the API is deployed.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ WebSocketStage

Returns a new instance of WebSocketStage.

Parameters:



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::WebSocketStageProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLldlYlNvY2tldFN0YWdlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_web_socket_stage_attributes(scope, id, attrs) ⇒ AWSCDK::APIGatewayv2::IWebSocketStage

Import an existing stage into this CDK app.

Parameters:

Returns:



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

def self.from_web_socket_stage_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::WebSocketStageAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLldlYlNvY2tldFN0YWdlQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.WebSocketStage", "fromWebSocketStageAttributes", [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_stage.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 => { kind: :property, name: "api", is_optional: false },
    :base_api => { kind: :property, name: "baseApi", is_optional: false },
    :callback_url => { kind: :property, name: "callbackUrl", is_optional: false },
    :stage_name => { kind: :property, name: "stageName", is_optional: false },
    :stage_ref => { kind: :property, name: "stageRef", is_optional: false },
    :url => { kind: :property, name: "url", is_optional: false },
    :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_stage_variable => { kind: :method, name: "addStageVariable", is_optional: false },
    :default_access_log_format => { kind: :method, name: "defaultAccessLogFormat", is_optional: false },
    :grant_management_api_access => { kind: :method, name: "grantManagementApiAccess", 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_stage.rb', line 107

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

Instance Method Details

#add_stage_variable(name, value) ⇒ void

This method returns an undefined value.

Adds a stage variable to this stage.

Parameters:

  • name (String)
  • value (String) 


248
249
250
251
252
 
# File 'api_gatewayv2/web_socket_stage.rb', line 248

def add_stage_variable(name, value)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  jsii_call_method("addStageVariable", [name, value])
end

#api ⇒ AWSCDK::APIGatewayv2::IWebSocketAPI

The API this stage is associated to.

Returns:



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

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



186
187
188
189
 
# File 'api_gatewayv2/web_socket_stage.rb', line 186

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:



203
204
205
206
 
# File 'api_gatewayv2/web_socket_stage.rb', line 203

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

#base_api ⇒ AWSCDK::APIGatewayv2::IAPI

Returns:



119
120
121
 
# File 'api_gatewayv2/web_socket_stage.rb', line 119

def base_api()
  jsii_get_property("baseApi")
end

#callback_url ⇒ String

The callback URL to this stage.

Returns:

  • (String) 


126
127
128
 
# File 'api_gatewayv2/web_socket_stage.rb', line 126

def callback_url()
  jsii_get_property("callbackUrl")
end

#default_access_log_format ⇒ AWSCDK::APIGateway::AccessLogFormat

CLF Log format for WebSocket API Stage.

Returns:

See Also:



258
259
260
 
# File 'api_gatewayv2/web_socket_stage.rb', line 258

def default_access_log_format()
  jsii_call_method("defaultAccessLogFormat", [])
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_stage.rb', line 79

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


209
210
211
 
# File 'api_gatewayv2/web_socket_stage.rb', line 209

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) 


223
224
225
226
227
228
 
# File 'api_gatewayv2/web_socket_stage.rb', line 223

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) 


238
239
240
241
 
# File 'api_gatewayv2/web_socket_stage.rb', line 238

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_management_api_access(identity) ⇒ AWSCDK::IAM::Grant

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

[disable-awslint:no-grants]

Parameters:

Returns:



268
269
270
271
 
# File 'api_gatewayv2/web_socket_stage.rb', line 268

def grant_management_api_access(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantManagementApiAccess", [identity])
end

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

Return the given named metric for this HTTP Api Gateway Stage.

Parameters:

Returns:



278
279
280
281
282
283
 
# File 'api_gatewayv2/web_socket_stage.rb', line 278

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_stage.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_stage.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_stage.rb', line 100

def stack()
  jsii_get_property("stack")
end

#stage_name ⇒ String

The name of the stage;

its primary identifier.

Returns:

  • (String) 


135
136
137
 
# File 'api_gatewayv2/web_socket_stage.rb', line 135

def stage_name()
  jsii_get_property("stageName")
end

#stage_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::StageReference

A reference to a Stage resource.

Returns:



142
143
144
 
# File 'api_gatewayv2/web_socket_stage.rb', line 142

def stage_ref()
  jsii_get_property("stageRef")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


156
157
158
 
# File 'api_gatewayv2/web_socket_stage.rb', line 156

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

#url ⇒ String

The websocket URL to this stage.

Returns:

  • (String) 


149
150
151
 
# File 'api_gatewayv2/web_socket_stage.rb', line 149

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


169
170
171
172
173
174
 
# File 'api_gatewayv2/web_socket_stage.rb', line 169

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