software.amazon.awscdk.services.apigateway

Interface IUsagePlan

All Superinterfaces:

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

All Known Subinterfaces:

IUsagePlan.Jsii$Default

All Known Implementing Classes:

IUsagePlan.Jsii$Proxy, UsagePlan

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.169Z")
 @Stability(value=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 and Description
static interface	IUsagePlan.Jsii$Default Internal default implementation for IUsagePlan.
static class	IUsagePlan.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and 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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getUsagePlanId

@Stability(value=Stable)
 @NotNull
String getUsagePlanId()

Id of the usage plan.

addApiKey

@Stability(value=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(value=Stable)
void addApiKey(@NotNull
                                        IApiKey apiKey)

Adds an ApiKey.

Parameters:

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