Interface WebSocketRouteIntegrationConfig
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
WebSocketRouteIntegrationConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-08T21:35:02.236Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forWebSocketRouteIntegrationConfig
static final class
An implementation forWebSocketRouteIntegrationConfig
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default ContentHandling
Specifies how to handle response payload content type conversions.default IRole
Credentials role.default String
Integration method.default PassthroughBehavior
Integration passthrough behaviors.Request parameters.Request template.default String
Template selection expression.default Duration
The maximum amount of time an integration will run before it returns without a response.getType()
Integration type.getUri()
Integration URI.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getType
Integration type. -
getUri
Integration URI. -
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
Credentials role.Default: - No role provided.
-
getMethod
Integration method.Default: - No integration method.
-
getPassthroughBehavior
Integration passthrough behaviors.Default: - No pass through bahavior.
-
getRequestParameters
Request parameters.Default: - No request parameters provided.
-
getRequestTemplates
Request template.Default: - No request template provided.
-
getTemplateSelectionExpression
Template selection expression.Default: - No template selection expression.
-
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
-