interface RateLimitedApiKeyProps

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.RateLimitedApiKeyProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#RateLimitedApiKeyProps
Java	software.amazon.awscdk.services.apigatewayv2.RateLimitedApiKeyProps
Python	aws_cdk.aws_apigatewayv2.RateLimitedApiKeyProps
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » RateLimitedApiKeyProps

RateLimitedApiKey properties.

Example

declare const api: apigwv2.WebSocketApi;
declare const stage: apigwv2.WebSocketStage;

const key = new apigwv2.RateLimitedApiKey(this, 'rate-limited-api-key', {
  customerId: 'test-customer',
  apiStages: [{
    api: api,
    stage: stage
  }],
  quota: {
    limit: 10000,
    period: apigwv2.Period.MONTH
  },
  throttle: {
    rateLimit: 100,
    burstLimit: 200
  }
});

Properties

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.
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.
throttle?	ThrottleSettings	Overall throttle settings for the API.
value?	string	The value of the API key.

---

apiKeyName?

Type: string (optional, default: automatically 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.

---

customerId?

Type: string (optional, default: none)

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

---

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.

---

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.