WebSocketRouteIntegrationConfig Struct
Config returned back as a result of the bind.
| 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;
const webSocketRouteIntegrationConfig: apigatewayv2.WebSocketRouteIntegrationConfig = {
type: apigatewayv2.WebSocketIntegrationType.AWS_PROXY,
uri: 'uri',
// the properties below are optional
contentHandling: apigatewayv2.ContentHandling.CONVERT_TO_BINARY,
credentialsRole: role,
method: 'method',
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_route_integration_config = apigatewayv2.WebSocketRouteIntegrationConfig(
type=apigatewayv2.WebSocketIntegrationType.AWS_PROXY,
uri="uri",
# the properties below are optional
content_handling=apigatewayv2.ContentHandling.CONVERT_TO_BINARY,
credentials_role=role,
method="method",
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;
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();
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;
var webSocketRouteIntegrationConfig = new WebSocketRouteIntegrationConfig {
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 = 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
webSocketRouteIntegrationConfig := &WebSocketRouteIntegrationConfig{
Type: awscdk.Aws_apigatewayv2.WebSocketIntegrationType_AWS_PROXY,
Uri: jsii.String("uri"),
// the properties below are optional
ContentHandling: awscdk.*Aws_apigatewayv2.ContentHandling_CONVERT_TO_BINARY,
CredentialsRole: role,
Method: jsii.String("method"),
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 #Credentials role.
Default: No role provided.
methodoptionalstringmethodoptionalstrmethodoptionalStringMethodoptionalstringMethodoptional*string #Integration method.
Default: No integration method.
passthroughBehavioroptionalPassthroughBehaviorpassthrough_behavioroptionalPassthroughBehaviorpassthroughBehavioroptionalPassthroughBehaviorPassthroughBehavioroptionalPassthroughBehaviorPassthroughBehavioroptionalPassthroughBehavior #Integration passthrough behaviors.
Default: No pass through bahavior.
requestParametersoptional{ [key: string]: string }request_parametersoptionaltyping.Mapping[str, str]requestParametersoptionalMap<String, String>RequestParametersoptionalIDictionary<string, string>RequestParametersoptional*map[string]*string #Request parameters.
Default: No request parameters provided.
requestTemplatesoptional{ [key: string]: string }request_templatesoptionaltyping.Mapping[str, str]requestTemplatesoptionalMap<String, String>RequestTemplatesoptionalIDictionary<string, string>RequestTemplatesoptional*map[string]*string #Request template.
Default: No request template provided.
templateSelectionExpressionoptionalstringtemplate_selection_expressionoptionalstrtemplateSelectionExpressionoptionalStringTemplateSelectionExpressionoptionalstringTemplateSelectionExpressionoptional*string #Template selection expression.
Default: No template selection expression.
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.
typeWebSocketIntegrationTypetypeWebSocketIntegrationTypetypeWebSocketIntegrationTypeTypeWebSocketIntegrationTypeTypeWebSocketIntegrationType required #Integration type.
Integration URI.