Package software.amazon.awscdk.services.apigateway

Enum ResponseTransferMode

java.lang.Object

java.lang.Enum<ResponseTransferMode>

software.amazon.awscdk.services.apigateway.ResponseTransferMode

All Implemented Interfaces:

Serializable, Comparable<ResponseTransferMode>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T10:47:11.581Z")
@Stability(Stable)
public enum ResponseTransferMode
extends Enum<ResponseTransferMode>

The response transfer mode of the integration.

Example:

 Function handler;
 LambdaIntegration.Builder.create(handler)
         .responseTransferMode(ResponseTransferMode.STREAM)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUFFERED	API Gateway waits to receive the complete response before beginning transmission.
STREAM	API Gateway streams the response back to you as it is received from the integration.

Method Summary

Modifier and Type	Method	Description
static ResponseTransferMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ResponseTransferMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BUFFERED

@Stability(Stable)
public static final ResponseTransferMode BUFFERED

API Gateway waits to receive the complete response before beginning transmission.

STREAM

@Stability(Stable)
public static final ResponseTransferMode STREAM

API Gateway streams the response back to you as it is received from the integration.

This is only supported for AWS_PROXY and HTTP_PROXY integration types.

Method Details

values

public static ResponseTransferMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResponseTransferMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null