aws-cdk-lib/aws-apigatewayv2-integrations/lib/websocket/aws.d.ts

Version 2 of the AWS Cloud Development Kit library

import { WebSocketRouteIntegration, WebSocketRouteIntegrationConfig, WebSocketRouteIntegrationBindOptions, PassthroughBehavior, ContentHandling } from '../../../aws-apigatewayv2';
import { IRole } from '../../../aws-iam';
import { Duration } from '../../../core';
/**
 * Props for AWS type integration for a WebSocket Api.
 */
export interface WebSocketAwsIntegrationProps {
    /**
     * Integration URI.
     */
    readonly integrationUri: string;
    /**
     * Specifies the integration's HTTP method type.
     */
    readonly integrationMethod: string;
    /**
     * 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.
     */
    readonly contentHandling?: ContentHandling;
    /**
     * Specifies the credentials role required for the integration.
     *
     * @default - No credential role provided.
     */
    readonly credentialsRole?: IRole;
    /**
     * The request parameters that API Gateway sends with the backend request.
     * Specify request parameters as key-value pairs (string-to-string
     * mappings), with a destination as the key and a source as the value.
     *
     * @default - No request parameter provided to the integration.
     */
    readonly requestParameters?: {
        [dest: string]: string;
    };
    /**
     * A map of Apache Velocity templates that are applied on the request
     * payload.
     *
     * ```
     *   { "application/json": "{ \"statusCode\": 200 }" }
     * ```
     *
     * @default - No request template provided to the integration.
     */
    readonly requestTemplates?: {
        [contentType: string]: string;
    };
    /**
     * The template selection expression for the integration.
     *
     * @default - No template selection expression provided.
     */
    readonly templateSelectionExpression?: string;
    /**
     * 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)
     */
    readonly timeout?: Duration;
    /**
     * 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.
     * There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
     * NEVER.
     *
     * @default - No passthrough behavior required.
     */
    readonly passthroughBehavior?: PassthroughBehavior;
}
/**
 * AWS WebSocket AWS Type Integration
 */
export declare class WebSocketAwsIntegration extends WebSocketRouteIntegration {
    private readonly props;
    /**
     * @param id id of the underlying integration construct
     */
    constructor(id: string, props: WebSocketAwsIntegrationProps);
    bind(_options: WebSocketRouteIntegrationBindOptions): WebSocketRouteIntegrationConfig;
}