Package software.amazon.awscdk.services.lambda

Enum InvokeMode

java.lang.Object

java.lang.Enum<InvokeMode>

software.amazon.awscdk.services.lambda.InvokeMode

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.276Z")
@Stability(Stable)
public enum InvokeMode
extends Enum<InvokeMode>

The invoke modes for a Lambda function.

Example:

 Function fn;
 fn.addFunctionUrl(FunctionUrlOptions.builder()
         .authType(FunctionUrlAuthType.NONE)
         .invokeMode(InvokeMode.RESPONSE_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	Default option.
RESPONSE_STREAM	Your function streams payload results as they become available.

Method Summary

Modifier and Type	Method	Description
static InvokeMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InvokeMode[]	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 InvokeMode BUFFERED

Default option.

Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

RESPONSE_STREAM

@Stability(Stable)
public static final InvokeMode RESPONSE_STREAM

Your function streams payload results as they become available.

Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

Method Details

values

public static InvokeMode[] 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 InvokeMode 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