aws-cdk-lib.aws_apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty

interface IntegrationOverridesProperty

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnApiGatewayManagedOverrides_IntegrationOverridesProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty
Pythonaws_cdk.aws_apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnApiGatewayManagedOverrides » IntegrationOverridesProperty

The IntegrationOverrides property overrides the integration settings for an API Gateway-managed integration.

If you remove this property, API Gateway restores the default values.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const integrationOverridesProperty: apigatewayv2.CfnApiGatewayManagedOverrides.IntegrationOverridesProperty = {
  description: 'description',
  integrationMethod: 'integrationMethod',
  payloadFormatVersion: 'payloadFormatVersion',
  timeoutInMillis: 123,
};

Properties

NameTypeDescription
description?stringThe description of the integration.
integrationMethod?stringSpecifies the integration's HTTP method type.
payloadFormatVersion?stringSpecifies the format of the payload sent to an integration.
timeoutInMillis?numberCustom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

description?

Type: string (optional)

The description of the integration.


integrationMethod?

Type: string (optional)

Specifies the integration's HTTP method type.


payloadFormatVersion?

Type: string (optional)

Specifies the format of the payload sent to an integration.

Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .


timeoutInMillis?

Type: number (optional)

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.