Package software.amazon.awscdk.services.apigatewayv2

Interface CfnApiGatewayManagedOverrides.IntegrationOverridesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Jsii$Proxy

Enclosing class:

CfnApiGatewayManagedOverrides

@Stability(Stable)
public static interface CfnApiGatewayManagedOverrides.IntegrationOverridesProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.apigatewayv2.*;
 IntegrationOverridesProperty integrationOverridesProperty = IntegrationOverridesProperty.builder()
         .description("description")
         .integrationMethod("integrationMethod")
         .payloadFormatVersion("payloadFormatVersion")
         .timeoutInMillis(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Builder	A builder for CfnApiGatewayManagedOverrides.IntegrationOverridesProperty
static final class	CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Jsii$Proxy	An implementation for CfnApiGatewayManagedOverrides.IntegrationOverridesProperty

Method Summary

Modifier and Type	Method	Description
static CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Builder	builder()
default String	getDescription()	The description of the integration.
default String	getIntegrationMethod()	Specifies the integration's HTTP method type.
default String	getPayloadFormatVersion()	Specifies the format of the payload sent to an integration.
default Number	getTimeoutInMillis()	Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-description

getIntegrationMethod

@Stability(Stable)
@Nullable
default String getIntegrationMethod()

Specifies the integration's HTTP method type.

For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-integrationmethod

getPayloadFormatVersion

@Stability(Stable)
@Nullable
default String getPayloadFormatVersion()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-payloadformatversion

getTimeoutInMillis

@Stability(Stable)
@Nullable
default Number getTimeoutInMillis()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-integrationoverrides-timeoutinmillis

builder

@Stability(Stable)
static CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Builder builder()

Returns:

a CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Builder of CfnApiGatewayManagedOverrides.IntegrationOverridesProperty