Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:21.432Z")
@Stability(Stable)
public interface WebSocketIntegrationProps
extends software.amazon.jsii.JsiiSerializable

The integration properties.

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;
 WebSocketIntegrationProps webSocketIntegrationProps = WebSocketIntegrationProps.builder()
         .integrationType(WebSocketIntegrationType.AWS_PROXY)
         .integrationUri("integrationUri")
         .webSocketApi(webSocketApi)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WebSocketIntegrationProps.Builder	builder()
WebSocketIntegrationType	getIntegrationType()	Integration type.
String	getIntegrationUri()	Integration URI.
IWebSocketApi	getWebSocketApi()	The WebSocket API to which this integration should be bound.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIntegrationType

@Stability(Stable)
@NotNull
WebSocketIntegrationType getIntegrationType()

Integration type.

getIntegrationUri

@Stability(Stable)
@NotNull
String getIntegrationUri()

Integration URI.

getWebSocketApi

@Stability(Stable)
@NotNull
IWebSocketApi getWebSocketApi()

The WebSocket API to which this integration should be bound.

builder

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

Returns:

a WebSocketIntegrationProps.Builder of WebSocketIntegrationProps