AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

RateLimitedApiKey

An API Gateway ApiKey, for which a rate limiting configuration can be specified.

Import

import { RateLimitedApiKey } from 'aws-cdk-lib/aws-apigatewayv2';

Or use the module namespace:

import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.RateLimitedApiKey

Properties

Configuration passed to the constructor as RateLimitedApiKeyProps.

apiStagesOptional
UsagePlanPerApiStage[]

API Stages to be associated with the RateLimitedApiKey.

Default: none

quotaOptional
QuotaSettings

Number of requests clients can make in a given time period.

Default: none

throttleOptional
ThrottleSettings

Overall throttle settings for the API.

Default: none

3 properties inherited from ApiKeyProps
customerIdOptionalinherited from ApiKeyProps
string

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

Default: none

enabledOptionalinherited from ApiKeyProps
boolean

Indicates whether the API key can be used by clients.

Default: true

generateDistinctIdOptionalinherited from ApiKeyProps
boolean

Specifies whether the key identifier is distinct from the created API key value.

Default: false

3 properties inherited from ApiKeyOptions
apiKeyNameOptionalinherited from ApiKeyOptions
string

A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

Default: automatically generated name

descriptionOptionalinherited from ApiKeyOptions
string

A description of the purpose of the API key.

Default: none

valueOptionalinherited from ApiKeyOptions
string

The value of the API key. Must be at least 20 characters long.

Default: none

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)
Moduleaws-apigatewayv2
Properties9

Related Constructs

Explore This Service

External Links