Package software.amazon.awscdk.services.apigatewayv2

Interface IUsagePlan

All Superinterfaces:

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

All Known Subinterfaces:

IUsagePlan.Jsii$Default

All Known Implementing Classes:

IUsagePlan.Jsii$Proxy, UsagePlan

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:13.889Z")
@Stability(Stable)
public interface IUsagePlan
extends software.amazon.jsii.JsiiSerializable, IResource

A UsagePlan, either managed by this CDK app, or imported.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IUsagePlan.Jsii$Default	Internal default implementation for IUsagePlan.
static final class	IUsagePlan.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
void	addApiKey(IApiKey apiKey)	Adds an ApiKey.
void	addApiKey(IApiKey apiKey, AddApiKeyOptions options)	Adds an ApiKey.
String	getUsagePlanId()	Id of the usage plan.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUsagePlanId

@Stability(Stable)
@NotNull
String getUsagePlanId()

Id of the usage plan.

addApiKey

@Stability(Stable)
void addApiKey(@NotNull
 IApiKey apiKey,
 @Nullable
 AddApiKeyOptions options)

Adds an ApiKey.

Parameters:

apiKey - the api key to associate with this usage plan. This parameter is required.

options - options that control the behaviour of this method.

addApiKey

@Stability(Stable)
void addApiKey(@NotNull
 IApiKey apiKey)

Adds an ApiKey.

Parameters:

apiKey - the api key to associate with this usage plan. This parameter is required.