software.amazon.awscdk.services.apigatewayv2

Interface CfnApiGatewayManagedOverrides.IntegrationOverridesProperty

All Known Implementing Classes:

CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Jsii$Proxy

Enclosing class:

CfnApiGatewayManagedOverrides

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getDescription

default java.lang.String getDescription()

The description of the integration.

getIntegrationMethod

default java.lang.String getIntegrationMethod()

Specifies the integration's HTTP method type.

getPayloadFormatVersion

default java.lang.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 .

getTimeoutInMillis

default java.lang.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.

builder

static CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Builder builder()

Returns:

a CfnApiGatewayManagedOverrides.IntegrationOverridesProperty.Builder of CfnApiGatewayManagedOverrides.IntegrationOverridesProperty