Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketRouteIntegrationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketRouteIntegrationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.136Z")
@Stability(Stable)
public interface WebSocketRouteIntegrationConfig
extends software.amazon.jsii.JsiiSerializable

Config returned back as a result of the bind.

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;
 WebSocketRouteIntegrationConfig webSocketRouteIntegrationConfig = WebSocketRouteIntegrationConfig.builder()
         .type(WebSocketIntegrationType.AWS_PROXY)
         .uri("uri")
         // the properties below are optional
         .contentHandling(ContentHandling.CONVERT_TO_BINARY)
         .credentialsRole(role)
         .method("method")
         .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	Interface	Description
static final class	WebSocketRouteIntegrationConfig.Builder	A builder for WebSocketRouteIntegrationConfig
static final class	WebSocketRouteIntegrationConfig.Jsii$Proxy	An implementation for WebSocketRouteIntegrationConfig

Method Summary

Modifier and Type	Method	Description
static WebSocketRouteIntegrationConfig.Builder	builder()
default ContentHandling	getContentHandling()	Specifies how to handle response payload content type conversions.
default IRole	getCredentialsRole()	Credentials role.
default String	getMethod()	Integration method.
default PassthroughBehavior	getPassthroughBehavior()	Integration passthrough behaviors.
default Map<String,String>	getRequestParameters()	Request parameters.
default Map<String,String>	getRequestTemplates()	Request template.
default String	getTemplateSelectionExpression()	Template selection expression.
default Duration	getTimeout()	The maximum amount of time an integration will run before it returns without a response.
WebSocketIntegrationType	getType()	Integration type.
String	getUri()	Integration URI.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
WebSocketIntegrationType getType()

Integration type.

getUri

@Stability(Stable)
@NotNull
String getUri()

Integration URI.

getContentHandling

@Stability(Stable)
@Nullable
default ContentHandling getContentHandling()

Specifies how to handle response payload content type conversions.

Default: - The response payload will be passed through from the integration response to the route response or method response without modification.

getCredentialsRole

@Stability(Stable)
@Nullable
default IRole getCredentialsRole()

Credentials role.

Default: - No role provided.

getMethod

@Stability(Stable)
@Nullable
default String getMethod()

Integration method.

Default: - No integration method.

getPassthroughBehavior

@Stability(Stable)
@Nullable
default PassthroughBehavior getPassthroughBehavior()

Integration passthrough behaviors.

Default: - No pass through bahavior.

getRequestParameters

@Stability(Stable)
@Nullable
default Map<String,String> getRequestParameters()

Request parameters.

Default: - No request parameters provided.

getRequestTemplates

@Stability(Stable)
@Nullable
default Map<String,String> getRequestTemplates()

Request template.

Default: - No request template provided.

getTemplateSelectionExpression

@Stability(Stable)
@Nullable
default String getTemplateSelectionExpression()

Template selection expression.

Default: - No template selection expression.

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

The maximum amount of time an integration will run before it returns without a response.

Must be between 50 milliseconds and 29 seconds.

Default: Duration.seconds(29)

builder

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

Returns:

a WebSocketRouteIntegrationConfig.Builder of WebSocketRouteIntegrationConfig