interface WebSocketRouteIntegrationConfig
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.WebSocketRouteIntegrationConfig |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#WebSocketRouteIntegrationConfig |
![]() | software.amazon.awscdk.services.apigatewayv2.WebSocketRouteIntegrationConfig |
![]() | aws_cdk.aws_apigatewayv2.WebSocketRouteIntegrationConfig |
![]() | aws-cdk-lib » aws_apigatewayv2 » WebSocketRouteIntegrationConfig |
Obtainable from
Web
.bind()
, Web
.bind()
, Web
.bind()
, Web
.bind()
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 * 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),
};
Properties
Name | Type | Description |
---|---|---|
type | Web | Integration type. |
uri | string | Integration URI. |
content | Content | Specifies how to handle response payload content type conversions. |
credentials | IRole | Credentials role. |
method? | string | Integration method. |
passthrough | Passthrough | Integration passthrough behaviors. |
request | { [string]: string } | Request parameters. |
request | { [string]: string } | Request template. |
template | string | Template selection expression. |
timeout? | Duration | The maximum amount of time an integration will run before it returns without a response. |
type
Type:
Web
Integration type.
uri
Type:
string
Integration URI.
contentHandling?
Type:
Content
(optional, default: The response payload will be passed through from the integration response to
the route response or method response without modification.)
Specifies how to handle response payload content type conversions.
credentialsRole?
Type:
IRole
(optional, default: No role provided.)
Credentials role.
method?
Type:
string
(optional, default: No integration method.)
Integration method.
passthroughBehavior?
Type:
Passthrough
(optional, default: No pass through bahavior.)
Integration passthrough behaviors.
requestParameters?
Type:
{ [string]: string }
(optional, default: No request parameters provided.)
Request parameters.
requestTemplates?
Type:
{ [string]: string }
(optional, default: No request template provided.)
Request template.
templateSelectionExpression?
Type:
string
(optional, default: No template selection expression.)
Template selection expression.
timeout?
Type:
Duration
(optional, default: 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.