WebSocketIntegrationProps Struct
The integration properties.
| Source | aws-apigatewayv2/lib/websocket/integration.ts |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
declare const role: iam.Role;
declare const webSocketApiRef: apigatewayv2.IWebSocketApiRef;
const webSocketIntegrationProps: apigatewayv2.WebSocketIntegrationProps = {
integrationType: apigatewayv2.WebSocketIntegrationType.AWS_PROXY,
integrationUri: 'integrationUri',
webSocketApi: webSocketApiRef,
// the properties below are optional
contentHandling: apigatewayv2.ContentHandling.CONVERT_TO_BINARY,
credentialsRole: role,
integrationMethod: 'integrationMethod',
passthroughBehavior: apigatewayv2.PassthroughBehavior.WHEN_NO_MATCH,
requestParameters: {
requestParametersKey: 'requestParameters',
},
requestTemplates: {
requestTemplatesKey: 'requestTemplates',
},
templateSelectionExpression: 'templateSelectionExpression',
timeout: cdk.Duration.minutes(30),
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_apigatewayv2 as apigatewayv2
from aws_cdk import aws_iam as iam
# role: iam.Role
# web_socket_api_ref: apigatewayv2.IWebSocketApiRef
web_socket_integration_props = apigatewayv2.WebSocketIntegrationProps(
integration_type=apigatewayv2.WebSocketIntegrationType.AWS_PROXY,
integration_uri="integrationUri",
web_socket_api=web_socket_api_ref,
# the properties below are optional
content_handling=apigatewayv2.ContentHandling.CONVERT_TO_BINARY,
credentials_role=role,
integration_method="integrationMethod",
passthrough_behavior=apigatewayv2.PassthroughBehavior.WHEN_NO_MATCH,
request_parameters={
"request_parameters_key": "requestParameters"
},
request_templates={
"request_templates_key": "requestTemplates"
},
template_selection_expression="templateSelectionExpression",
timeout=cdk.Duration.minutes(30)
)
java
// 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;
IWebSocketApiRef webSocketApiRef;
WebSocketIntegrationProps webSocketIntegrationProps = WebSocketIntegrationProps.builder()
.integrationType(WebSocketIntegrationType.AWS_PROXY)
.integrationUri("integrationUri")
.webSocketApi(webSocketApiRef)
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Apigatewayv2;
using Amazon.CDK.AWS.IAM;
Role role;
IWebSocketApiRef webSocketApiRef;
var webSocketIntegrationProps = new WebSocketIntegrationProps {
IntegrationType = WebSocketIntegrationType.AWS_PROXY,
IntegrationUri = "integrationUri",
WebSocketApi = webSocketApiRef,
// the properties below are optional
ContentHandling = ContentHandling.CONVERT_TO_BINARY,
CredentialsRole = role,
IntegrationMethod = "integrationMethod",
PassthroughBehavior = PassthroughBehavior.WHEN_NO_MATCH,
RequestParameters = new Dictionary<string, string> {
{ "requestParametersKey", "requestParameters" }
},
RequestTemplates = new Dictionary<string, string> {
{ "requestTemplatesKey", "requestTemplates" }
},
TemplateSelectionExpression = "templateSelectionExpression",
Timeout = Duration.Minutes(30)
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var role Role
var webSocketApiRef IWebSocketApiRef
webSocketIntegrationProps := &WebSocketIntegrationProps{
IntegrationType: awscdk.Aws_apigatewayv2.WebSocketIntegrationType_AWS_PROXY,
IntegrationUri: jsii.String("integrationUri"),
WebSocketApi: webSocketApiRef,
// the properties below are optional
ContentHandling: awscdk.*Aws_apigatewayv2.ContentHandling_CONVERT_TO_BINARY,
CredentialsRole: role,
IntegrationMethod: jsii.String("integrationMethod"),
PassthroughBehavior: awscdk.*Aws_apigatewayv2.PassthroughBehavior_WHEN_NO_MATCH,
RequestParameters: map[string]*string{
"requestParametersKey": jsii.String("requestParameters"),
},
RequestTemplates: map[string]*string{
"requestTemplatesKey": jsii.String("requestTemplates"),
},
TemplateSelectionExpression: jsii.String("templateSelectionExpression"),
Timeout: cdk.Duration_Minutes(jsii.Number(30)),
}
Properties
contentHandlingoptionalContentHandlingcontent_handlingoptionalContentHandlingcontentHandlingoptionalContentHandlingContentHandlingoptionalContentHandlingContentHandlingoptionalContentHandling #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.
credentialsRoleoptionalIRolecredentials_roleoptionalIRolecredentialsRoleoptionalIRoleCredentialsRoleoptionalIRoleCredentialsRoleoptionalIRole #Specifies the IAM role required for the integration.
Default: No IAM role required.
integrationMethodoptionalstringintegration_methodoptionalstrintegrationMethodoptionalStringIntegrationMethodoptionalstringIntegrationMethodoptional*string #Specifies the integration's HTTP method type.
Default: No HTTP method required.
integrationTypeWebSocketIntegrationTypeintegration_typeWebSocketIntegrationTypeintegrationTypeWebSocketIntegrationTypeIntegrationTypeWebSocketIntegrationTypeIntegrationTypeWebSocketIntegrationType required #Integration type.
integrationUristringintegration_uristrintegrationUriStringIntegrationUristringIntegrationUri*string required #Integration URI.
passthroughBehavioroptionalPassthroughBehaviorpassthrough_behavioroptionalPassthroughBehaviorpassthroughBehavioroptionalPassthroughBehaviorPassthroughBehavioroptionalPassthroughBehaviorPassthroughBehavioroptionalPassthroughBehavior #Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
Default: No passthrough behavior required.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
requestParametersoptional{ [key: string]: string }request_parametersoptionaltyping.Mapping[str, str]requestParametersoptionalMap<String, String>RequestParametersoptionalIDictionary<string, string>RequestParametersoptional*map[string]*string #The request parameters that API Gateway sends with the backend request.
Default: No request parameters required.
Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.
requestTemplatesoptional{ [key: string]: string }request_templatesoptionaltyping.Mapping[str, str]requestTemplatesoptionalMap<String, String>RequestTemplatesoptionalIDictionary<string, string>RequestTemplatesoptional*map[string]*string #A map of Apache Velocity templates that are applied on the request payload.
Default: No request templates required.
{ "application/json": "{ \"statusCode\": 200 }" }
templateSelectionExpressionoptionalstringtemplate_selection_expressionoptionalstrtemplateSelectionExpressionoptionalStringTemplateSelectionExpressionoptionalstringTemplateSelectionExpressionoptional*string #The template selection expression for the integration.
Default: No template selection expression required.
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration = Duration.seconds(29) #The maximum amount of time an integration will run before it returns without a response.
Must be between 50 milliseconds and 29 seconds.
webSocketApiIWebSocketApiRefweb_socket_apiIWebSocketApiRefwebSocketApiIWebSocketApiRefWebSocketApiIWebSocketApiRefWebSocketApiIWebSocketApiRef required #The WebSocket API to which this integration should be bound.