Class WebSocketStage
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.Resource
software.amazon.awscdk.services.apigatewayv2.WebSocketStage
- All Implemented Interfaces:
IConstruct
,IDependable
,IResource
,IStage
,IWebSocketStage
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:43.359Z")
@Stability(Experimental)
public class WebSocketStage
extends Resource
implements IWebSocketStage, IStage
(experimental) Represents a stage where an instance of the API is deployed.
Example:
import software.amazon.awscdk.services.apigatewayv2.integrations.WebSocketLambdaIntegration; Function messageHandler; WebSocketApi webSocketApi = new WebSocketApi(this, "mywsapi"); WebSocketStage.Builder.create(this, "mystage") .webSocketApi(webSocketApi) .stageName("dev") .autoDeploy(true) .build(); webSocketApi.addRoute("sendmessage", WebSocketRouteOptions.builder() .integration(new WebSocketLambdaIntegration("SendMessageIntegration", messageHandler)) .build());
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
(experimental) A fluent builder forWebSocketStage
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IStage
IStage.Jsii$Default, IStage.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketStage
IWebSocketStage.Jsii$Default, IWebSocketStage.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
WebSocketStage
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
WebSocketStage
(software.amazon.jsii.JsiiObjectRef objRef) WebSocketStage
(software.constructs.Construct scope, String id, WebSocketStageProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IWebSocketStage
fromWebSocketStageAttributes
(software.constructs.Construct scope, String id, WebSocketStageAttributes attrs) (experimental) Import an existing stage into this CDK app.getApi()
(experimental) The API this stage is associated to.protected IApi
(experimental) The callback URL to this stage.(experimental) The name of the stage;getUrl()
(experimental) The websocket URL to this stage.grantManagementApiAccess
(IGrantable identity) (experimental) Grant access to the API Gateway management API for this WebSocket API Stage to an IAM principal (Role/Group/User).(experimental) Return the given named metric for this HTTP Api Gateway Stage.metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage.Methods inherited from class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.constructs.Construct
toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
WebSocketStage
protected WebSocketStage(software.amazon.jsii.JsiiObjectRef objRef) -
WebSocketStage
protected WebSocketStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
WebSocketStage
@Stability(Experimental) public WebSocketStage(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull WebSocketStageProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
fromWebSocketStageAttributes
@Stability(Experimental) @NotNull public static IWebSocketStage fromWebSocketStageAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull WebSocketStageAttributes attrs) (experimental) Import an existing stage into this CDK app.- Parameters:
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.
-
grantManagementApiAccess
@Stability(Experimental) @NotNull public Grant grantManagementApiAccess(@NotNull IGrantable identity) (experimental) Grant access to the API Gateway management API for this WebSocket API Stage to an IAM principal (Role/Group/User).- Parameters:
identity
- The principal. This parameter is required.
-
metric
@Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage. -
metric
(experimental) Return the given named metric for this HTTP Api Gateway Stage. -
getApi
(experimental) The API this stage is associated to.- Specified by:
getApi
in interfaceIWebSocketStage
-
getBaseApi
-
getCallbackUrl
(experimental) The callback URL to this stage.- Specified by:
getCallbackUrl
in interfaceIWebSocketStage
-
getStageName
(experimental) The name of the stage;its primary identifier.
- Specified by:
getStageName
in interfaceIStage
-
getUrl
(experimental) The websocket URL to this stage.
-