software.amazon.awscdk.services.apigatewayv2

Class WebSocketIntegration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.WebSocketIntegration

All Implemented Interfaces:

IConstruct, IDependable, IResource, IIntegration, IWebSocketIntegration

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.301Z")
public class WebSocketIntegration
extends Resource
implements IWebSocketIntegration

(experimental) The integration for an API route.

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;
 WebSocketIntegration webSocketIntegration = WebSocketIntegration.Builder.create(this, "MyWebSocketIntegration")
         .integrationType(WebSocketIntegrationType.AWS_PROXY)
         .integrationUri("integrationUri")
         .webSocketApi(webSocketApi)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocketIntegration.Builder (experimental) A fluent builder for WebSocketIntegration.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketIntegration

IWebSocketIntegration.Jsii$Default, IWebSocketIntegration.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketIntegration(software.amazon.jsii.JsiiObjectRef objRef)
	WebSocketIntegration(software.constructs.Construct scope, java.lang.String id, WebSocketIntegrationProps props)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIntegrationId() (experimental) Id of the integration.
IWebSocketApi	getWebSocketApi() (experimental) The WebSocket API associated with this integration.

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

WebSocketIntegration

protected WebSocketIntegration(software.amazon.jsii.JsiiObjectRef objRef)

WebSocketIntegration

protected WebSocketIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

WebSocketIntegration

public WebSocketIntegration(software.constructs.Construct scope,
                            java.lang.String id,
                            WebSocketIntegrationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getIntegrationId

public java.lang.String getIntegrationId()

(experimental) Id of the integration.

Specified by:

getIntegrationId in interface IIntegration

getWebSocketApi

public IWebSocketApi getWebSocketApi()

(experimental) The WebSocket API associated with this integration.

Specified by:

getWebSocketApi in interface IWebSocketIntegration