class RateLimitedApiKey (construct)

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.RateLimitedApiKey
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#RateLimitedApiKey
Java	software.amazon.awscdk.services.apigateway.RateLimitedApiKey
Python	aws_cdk.aws_apigateway.RateLimitedApiKey
TypeScript (source)	aws-cdk-lib » aws_apigateway » RateLimitedApiKey

Implements IConstruct, IDependable, IResource, IApiKey

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

Example

declare const api: apigateway.RestApi;

const key = new apigateway.RateLimitedApiKey(this, 'rate-limited-api-key', {
  customerId: 'hello-customer',
  apiStages: [{ stage: api.deploymentStage }],
  quota: {
    limit: 10000,
    period: apigateway.Period.MONTH
  }
});

Initializer

new RateLimitedApiKey(scope: Construct, id: string, props?: RateLimitedApiKeyProps)

Parameters

• scope Construct
• id string
• props RateLimitedApiKeyProps

Construct Props

Name	Type	Description
apiKeyName?	string	A name for the API key.
apiStages?	UsagePlanPerApiStage[]	API Stages to be associated with the RateLimitedApiKey.
customerId?	string	An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
defaultCorsPreflightOptions?	CorsOptions	Adds a CORS preflight OPTIONS method to this resource and all child resources.
defaultIntegration?	Integration	An integration to use as a default for all methods created within this API unless an integration is specified.
defaultMethodOptions?	MethodOptions	Method options to use as a default for all methods created within this API unless custom options are specified.
description?	string	A description of the purpose of the API key.
enabled?	boolean	Indicates whether the API key can be used by clients.
generateDistinctId?	boolean	Specifies whether the key identifier is distinct from the created API key value.
quota?	QuotaSettings	Number of requests clients can make in a given time period.
resources?⚠️	IRestApi[]	A list of resources this api key is associated with.
stages?	IStage[]	A list of Stages this api key is associated with.
throttle?	ThrottleSettings	Overall throttle settings for the API.
value?	string	The value of the API key.

---

apiKeyName?

Type: string (optional, default: automically generated name)

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.

---

apiStages?

Type: UsagePlanPerApiStage[] (optional, default: none)

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.

---

customerId?

Type: string (optional, default: none)

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

---

defaultCorsPreflightOptions?

Type: CorsOptions (optional, default: CORS is disabled)

Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

---

defaultIntegration?

Type: Integration (optional, default: Inherited from parent.)

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

---

defaultMethodOptions?

Type: MethodOptions (optional, default: Inherited from parent.)

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

---

description?

Type: string (optional, default: none)

A description of the purpose of the API key.

---

enabled?

Type: boolean (optional, default: true)

Indicates whether the API key can be used by clients.

---

generateDistinctId?

Type: boolean (optional, default: false)

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

---

quota?

Type: QuotaSettings (optional, default: none)

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

---

resources?⚠️

⚠️ Deprecated: - use stages instead

Type: IRestApi[] (optional, default: none)

A list of resources this api key is associated with.

---

stages?

Type: IStage[] (optional, default: the api key is not associated with any stages)

A list of Stages this api key is associated with.

---

throttle?

Type: ThrottleSettings (optional, default: none)

Overall throttle settings for the API.

---

value?

Type: string (optional, default: none)

The value of the API key.

Must be at least 20 characters long.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
keyArn	string	The API key ARN.
keyId	string	The API key ID.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

keyArn

Type: string

The API key ARN.

---

keyId

Type: string

The API key ID.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantRead(grantee)	Permits the IAM principal all read operations through this key.
grantReadWrite(grantee)	Permits the IAM principal all read and write operations through this key.
grantWrite(grantee)	Permits the IAM principal all write operations through this key.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantRead(grantee)

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant access to.

Returns

• Grant

Permits the IAM principal all read operations through this key.

---

grantReadWrite(grantee)

public grantReadWrite(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant access to.

Returns

• Grant

Permits the IAM principal all read and write operations through this key.

---

grantWrite(grantee)

public grantWrite(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant access to.

Returns

• Grant

Permits the IAM principal all write operations through this key.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.