AWS::ApiGatewayV2::ApiGatewayManagedOverrides IntegrationOverrides - AWS CloudFormation

AWS::ApiGatewayV2::ApiGatewayManagedOverrides IntegrationOverrides

The IntegrationOverrides property overrides the integration settings for an API Gateway-managed integration. If you remove this property, API Gateway restores the default values.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Description" : String, "IntegrationMethod" : String, "PayloadFormatVersion" : String, "TimeoutInMillis" : Integer }

YAML

Description: String IntegrationMethod: String PayloadFormatVersion: String TimeoutInMillis: Integer

Properties

Description

The description of the integration.

Required: No

Type: String

Update requires: No interruption

IntegrationMethod

Specifies the integration's HTTP method type.

Required: No

Type: String

Update requires: No interruption

PayloadFormatVersion

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.

Required: No

Type: String

Update requires: No interruption

TimeoutInMillis

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.

Required: No

Type: Integer

Update requires: No interruption