Package software.amazon.awscdk.services.apigatewayv2

Interface IUsagePlan.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IUsagePlan, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IUsagePlan.Jsii$Proxy

Enclosing interface:

IUsagePlan

@Internal
public static interface IUsagePlan.Jsii$Default
extends IUsagePlan, IResource.Jsii$Default

Internal default implementation for IUsagePlan.

Nested Class Summary

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

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

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

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

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

IResource.Jsii$Default, IResource.Jsii$Proxy

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

IUsagePlan.Jsii$Default, IUsagePlan.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.constructs.IConstruct.Jsii$Default

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUsagePlanId

@Stability(Stable)
@NotNull
default String getUsagePlanId()

Id of the usage plan.

Specified by:

getUsagePlanId in interface IUsagePlan

addApiKey

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

Adds an ApiKey.

Specified by:

addApiKey in interface IUsagePlan

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)
default void addApiKey(@NotNull
 IApiKey apiKey)

Adds an ApiKey.

Specified by:

addApiKey in interface IUsagePlan

Parameters:

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