Package software.amazon.awscdk.services.apigatewayv2

Class RateLimitedApiKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.RateLimitedApiKey

All Implemented Interfaces:

IResource, IApiKey, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-08-20T12:34:37.209Z")
@Stability(Stable)
public class RateLimitedApiKey
extends Resource
implements IApiKey

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

Example:

 WebSocketApi api;
 WebSocketStage stage;
 RateLimitedApiKey key = RateLimitedApiKey.Builder.create(this, "rate-limited-api-key")
         .customerId("test-customer")
         .apiStages(List.of(UsagePlanPerApiStage.builder()
                 .api(api)
                 .stage(stage)
                 .build()))
         .quota(QuotaSettings.builder()
                 .limit(10000)
                 .period(Period.MONTH)
                 .build())
         .throttle(ThrottleSettings.builder()
                 .rateLimit(100)
                 .burstLimit(200)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RateLimitedApiKey.Builder	A fluent builder for RateLimitedApiKey.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IApiKey

IApiKey.Jsii$Default, IApiKey.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RateLimitedApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RateLimitedApiKey(software.amazon.jsii.JsiiObjectRef objRef)
	RateLimitedApiKey(software.constructs.Construct scope, String id)
	RateLimitedApiKey(software.constructs.Construct scope, String id, RateLimitedApiKeyProps props)

Method Summary

Modifier and Type	Method	Description
String	getKeyArn()	The API key ARN.
String	getKeyId()	The API key ID.
Grant	grantRead(IGrantable grantee)	Permits the IAM principal all read operations through this key.
Grant	grantReadWrite(IGrantable grantee)	Permits the IAM principal all read and write operations through this key.
Grant	grantWrite(IGrantable grantee)	Permits the IAM principal all write operations through this key.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

RateLimitedApiKey

protected RateLimitedApiKey(software.amazon.jsii.JsiiObjectRef objRef)

RateLimitedApiKey

protected RateLimitedApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

RateLimitedApiKey

@Stability(Stable)
public RateLimitedApiKey(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 RateLimitedApiKeyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

RateLimitedApiKey

@Stability(Stable)
public RateLimitedApiKey(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

grantRead

@Stability(Stable)
@NotNull
public Grant grantRead(@NotNull
 IGrantable grantee)

Permits the IAM principal all read operations through this key.

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantReadWrite

@Stability(Stable)
@NotNull
public Grant grantReadWrite(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantWrite

@Stability(Stable)
@NotNull
public Grant grantWrite(@NotNull
 IGrantable grantee)

Permits the IAM principal all write operations through this key.

Parameters:

grantee - The principal to grant access to. This parameter is required.

getKeyArn

@Stability(Stable)
@NotNull
public String getKeyArn()

The API key ARN.

Specified by:

getKeyArn in interface IApiKey

getKeyId

@Stability(Stable)
@NotNull
public String getKeyId()

The API key ID.

Specified by:

getKeyId in interface IApiKey