Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.WebSocketIntegration

All Implemented Interfaces:

IEnvironmentAware, IResource, IIntegration, IWebSocketIntegration, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:13.921Z")
@Stability(Stable)
public class WebSocketIntegration
extends Resource
implements IWebSocketIntegration

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.*;
 import software.amazon.awscdk.services.apigatewayv2.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 WebSocketApi webSocketApi;
 WebSocketIntegration webSocketIntegration = WebSocketIntegration.Builder.create(this, "MyWebSocketIntegration")
         .integrationType(WebSocketIntegrationType.AWS_PROXY)
         .integrationUri("integrationUri")
         .webSocketApi(webSocketApi)
         // the properties below are optional
         .contentHandling(ContentHandling.CONVERT_TO_BINARY)
         .credentialsRole(role)
         .integrationMethod("integrationMethod")
         .passthroughBehavior(PassthroughBehavior.WHEN_NO_MATCH)
         .requestParameters(Map.of(
                 "requestParametersKey", "requestParameters"))
         .requestTemplates(Map.of(
                 "requestTemplatesKey", "requestTemplates"))
         .templateSelectionExpression("templateSelectionExpression")
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WebSocketIntegration.Builder	A fluent builder for WebSocketIntegration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

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

IWebSocketIntegration.Jsii$Default, IWebSocketIntegration.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

WebSocketIntegration

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

WebSocketIntegration

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

WebSocketIntegration

@Stability(Stable)
public WebSocketIntegration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 WebSocketIntegrationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getIntegrationId

@Stability(Stable)
@NotNull
public String getIntegrationId()

Id of the integration.

Specified by:

getIntegrationId in interface IIntegration

getWebSocketApi

@Stability(Stable)
@NotNull
public IWebSocketApi getWebSocketApi()

The WebSocket API associated with this integration.

Specified by:

getWebSocketApi in interface IWebSocketIntegration