software.amazon.awscdk.services.apigateway

Interface IUsagePlan.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.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.amazon.awscdk.services.apigateway.IUsagePlan

IUsagePlan.Jsii$Default, IUsagePlan.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	addApiKey(IApiKey apiKey, AddApiKeyOptions options) (experimental) Adds an ApiKey.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default String	getUsagePlanId() (experimental) Id of the usage plan.

Methods inherited from interface software.amazon.awscdk.services.apigateway.IUsagePlan

addApiKey

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getUsagePlanId

@Stability(value=Experimental)
 @NotNull
default String getUsagePlanId()

(experimental) Id of the usage plan.

Specified by:

getUsagePlanId in interface IUsagePlan

addApiKey

@Stability(value=Experimental)
default void addApiKey(@NotNull
                                                      IApiKey apiKey,
                                                      @Nullable
                                                      AddApiKeyOptions options)

(experimental) 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.