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-apigateway';

Or use the module namespace:

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

Properties

Configuration passed to the constructor as RateLimitedApiKeyProps.

apiStagesOptional
UsagePlanPerApiStage[]

API Stages to be associated with the RateLimitedApiKey. If you already prepared UsagePlan resource explicitly, you should use `stages` property. If you prefer to prepare UsagePlan resource implicitly via RateLimitedApiKey, or you should specify throttle settings at each stage individually, you should use `apiStages` property.

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

5 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

resourcesOptionalDeprecatedinherited from ApiKeyProps
IRestApi[]

A list of resources this api key is associated with.

Default: none

Deprecated: - use `stages` instead

stagesOptionalinherited from ApiKeyProps
IStage[]

A list of Stages this api key is associated with.

Default: - the api key is not associated with any stages

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: automically 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

3 properties inherited from ResourceOptions
defaultCorsPreflightOptionsOptionalinherited from ResourceOptions
CorsOptions

Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using `addCorsPreflight`.

Default: - CORS is disabled

defaultIntegrationOptionalinherited from ResourceOptions
Integration

An integration to use as a default for all methods created within this API unless an integration is specified.

Default: - Inherited from parent.

defaultMethodOptionsOptionalinherited from ResourceOptions
MethodOptions

Method options to use as a default for all methods created within this API unless custom options are specified.

Default: - Inherited from parent.

Get the Amazon API Gateway Cheat Sheet

Everything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-apigateway
Properties14

Related Constructs

Explore This Service

External Links