software.amazon.awscdk.services.apigateway

Enum ApiKeySourceType

java.lang.Object

java.lang.Enum<ApiKeySourceType>

software.amazon.awscdk.services.apigateway.ApiKeySourceType

All Implemented Interfaces:

Serializable, Comparable<ApiKeySourceType>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.085Z")
 @Stability(value=Stable)
public enum ApiKeySourceType
extends Enum<ApiKeySourceType>

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static ApiKeySourceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApiKeySourceType[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEADER

@Stability(value=Stable)
public static final ApiKeySourceType HEADER

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

AUTHORIZER

@Stability(value=Stable)
public static final ApiKeySourceType AUTHORIZER

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

Method Detail

values

public static ApiKeySourceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ApiKeySourceType c : ApiKeySourceType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ApiKeySourceType 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