Period

class aws_cdk.aws_apigatewayv2.Period(*values)

Bases: Enum

Time period for which quota settings apply.

ExampleMetadata:

infused

Example:

# api: apigwv2.WebSocketApi
# stage: apigwv2.WebSocketStage


key = apigwv2.RateLimitedApiKey(self, "rate-limited-api-key",
    customer_id="test-customer",
    api_stages=[apigwv2.UsagePlanPerApiStage(
        api=api,
        stage=stage
    )],
    quota=apigwv2.QuotaSettings(
        limit=10000,
        period=apigwv2.Period.MONTH
    ),
    throttle=apigwv2.ThrottleSettings(
        rate_limit=100,
        burst_limit=200
    )
)

Attributes

DAY

The quota resets every day.

MONTH

The quota resets every month.

WEEK

The quota resets every week.