software.amazon.awscdk.services.apigatewayv2.alpha

Interface WebSocketStageAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, StageAttributes

All Known Implementing Classes:

WebSocketStageAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-15T19:53:17.432Z")
 @Stability(value=Experimental)
public interface WebSocketStageAttributes
extends software.amazon.jsii.JsiiSerializable, StageAttributes

(experimental) The attributes used to import existing WebSocketStage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.alpha.*;
 WebSocketApi webSocketApi;
 WebSocketStageAttributes webSocketStageAttributes = WebSocketStageAttributes.builder()
         .api(webSocketApi)
         .stageName("stageName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketStageAttributes.Builder A builder for WebSocketStageAttributes
static class	WebSocketStageAttributes.Jsii$Proxy An implementation for WebSocketStageAttributes

Method Summary

Modifier and Type	Method and Description
static WebSocketStageAttributes.Builder	builder()
IWebSocketApi	getApi() (experimental) The API to which this stage is associated.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.alpha.StageAttributes

getStageName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApi

@Stability(value=Experimental)
 @NotNull
IWebSocketApi getApi()

(experimental) The API to which this stage is associated.

builder

@Stability(value=Experimental)
static WebSocketStageAttributes.Builder builder()

Specified by:

builder in interface StageAttributes

Returns:

a WebSocketStageAttributes.Builder of WebSocketStageAttributes