Package software.amazon.awscdk.services.apigateway

Enum Period

java.lang.Object

java.lang.Enum<Period>

software.amazon.awscdk.services.apigateway.Period

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:11.915Z")
@Stability(Stable)
public enum Period
extends Enum<Period>

Time period for which quota settings apply.

Example:

 RestApi api;
 RateLimitedApiKey key = RateLimitedApiKey.Builder.create(this, "rate-limited-api-key")
         .customerId("hello-customer")
         .stages(List.of(api.getDeploymentStage()))
         .quota(QuotaSettings.builder()
                 .limit(10000)
                 .period(Period.MONTH)
                 .build())
         .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
DAY
MONTH
WEEK

Method Summary

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

DAY

@Stability(Stable)
public static final Period DAY

WEEK

@Stability(Stable)
public static final Period WEEK

MONTH

@Stability(Stable)
public static final Period MONTH

Method Details

values

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