Package software.amazon.awscdk.services.apigateway

Enum Class ApiKeySourceType

java.lang.Object

java.lang.Enum<ApiKeySourceType>

software.amazon.awscdk.services.apigateway.ApiKeySourceType

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:06.253Z")
@Stability(Stable)
public enum ApiKeySourceType
extends Enum<ApiKeySourceType>

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
AUTHORIZER	To read the API key from the UsageIdentifierKey from a custom authorizer.
HEADER	To read the API key from the X-API-Key header of a request.

Method Summary

Modifier and Type	Method	Description
static ApiKeySourceType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiKeySourceType[]	values()	Returns an array containing the constants of this enum class, 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

HEADER

@Stability(Stable)
public static final ApiKeySourceType HEADER

To read the API key from the X-API-Key header of a request.

AUTHORIZER

@Stability(Stable)
public static final ApiKeySourceType AUTHORIZER

To read the API key from the UsageIdentifierKey from a custom authorizer.

Method Details

values

public static ApiKeySourceType[] values()

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

Returns:

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

valueOf

public static ApiKeySourceType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null