Class CfnApiGatewayManagedOverrides.IntegrationOverridesProperty
The IntegrationOverrides
property overrides the integration settings for an API Gateway-managed integration.
Inheritance
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class IntegrationOverridesProperty : Object, CfnApiGatewayManagedOverrides.IIntegrationOverridesProperty
Syntax (vb)
Public Class IntegrationOverridesProperty
Inherits Object
Implements CfnApiGatewayManagedOverrides.IIntegrationOverridesProperty
Remarks
If you remove this property, API Gateway restores the default values.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
var integrationOverridesProperty = new IntegrationOverridesProperty {
Description = "description",
IntegrationMethod = "integrationMethod",
PayloadFormatVersion = "payloadFormatVersion",
TimeoutInMillis = 123
};
Synopsis
Constructors
IntegrationOverridesProperty() |
Properties
Description | The description of the integration. |
IntegrationMethod | Specifies the integration's HTTP method type. |
PayloadFormatVersion | Specifies the format of the payload sent to an integration. |
TimeoutInMillis | Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. |
Constructors
IntegrationOverridesProperty()
public IntegrationOverridesProperty()
Properties
Description
The description of the integration.
public string Description { get; set; }
Property Value
System.String
Remarks
IntegrationMethod
Specifies the integration's HTTP method type.
public string IntegrationMethod { get; set; }
Property Value
System.String
Remarks
For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST
.
PayloadFormatVersion
Specifies the format of the payload sent to an integration.
public string PayloadFormatVersion { get; set; }
Property Value
System.String
Remarks
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
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
public Nullable<double> TimeoutInMillis { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.