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.94.0 (build b380f01)",
           date="2024-03-14T22:21:49.748Z")
@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.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
         .credentialsRole(role)
         .method("method")
         .passthroughBehavior(PassthroughBehavior.WHEN_NO_MATCH)
         .requestParameters(Map.of(
                 "requestParametersKey", "requestParameters"))
         .requestTemplates(Map.of(
                 "requestTemplatesKey", "requestTemplates"))
         .templateSelectionExpression("templateSelectionExpression")
         .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 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.
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.

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.

builder

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

Returns:

a WebSocketRouteIntegrationConfig.Builder of WebSocketRouteIntegrationConfig