Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketStageAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, StageAttributes

All Known Implementing Classes:

WebSocketStageAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:20.894Z")
@Stability(Stable)
public interface WebSocketStageAttributes
extends software.amazon.jsii.JsiiSerializable, StageAttributes

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.*;
 WebSocketApi webSocketApi;
 WebSocketStageAttributes webSocketStageAttributes = WebSocketStageAttributes.builder()
         .api(webSocketApi)
         .stageName("stageName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getStageName

Method Details

getApi

@Stability(Stable)
@NotNull
IWebSocketApi getApi()

The API to which this stage is associated.

builder

@Stability(Stable)
static WebSocketStageAttributes.Builder builder()

Returns:

a WebSocketStageAttributes.Builder of WebSocketStageAttributes