Package software.amazon.awscdk.services.apigateway

Class IUsagePlan.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.IUsagePlan.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IUsagePlan

@Internal
public static final class IUsagePlan.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IUsagePlan.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

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.apigateway.IUsagePlan

IUsagePlan.Jsii$Default, IUsagePlan.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.apigateway.IUsagePlanRef

IUsagePlanRef.Jsii$Default, IUsagePlanRef.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
final void	addApiKey(IApiKeyRef apiKey)	Adds an ApiKey.
final void	addApiKey(IApiKeyRef apiKey, AddApiKeyOptions options)	Adds an ApiKey.
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final software.constructs.Node	getNode()	The tree node.
final Stack	getStack()	The stack in which this resource is defined.
final String	getUsagePlanId()	Id of the usage plan.
final UsagePlanReference	getUsagePlanRef()	(experimental) A reference to a UsagePlan resource.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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

Specified by:

getNode in interface IUsagePlan

Specified by:

getNode in interface IUsagePlan.Jsii$Default

Specified by:

getNode in interface IUsagePlanRef.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IUsagePlan

Specified by:

getEnv in interface IUsagePlan.Jsii$Default

Specified by:

getEnv in interface IUsagePlanRef.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IUsagePlan.Jsii$Default

getUsagePlanRef

@Stability(Experimental)
@NotNull
public final UsagePlanReference getUsagePlanRef()

(experimental) A reference to a UsagePlan resource.

Specified by:

getUsagePlanRef in interface IUsagePlan.Jsii$Default

Specified by:

getUsagePlanRef in interface IUsagePlanRef

Specified by:

getUsagePlanRef in interface IUsagePlanRef.Jsii$Default

getUsagePlanId

@Stability(Stable)
@NotNull
public final String getUsagePlanId()

Id of the usage plan.

Specified by:

getUsagePlanId in interface IUsagePlan

Specified by:

getUsagePlanId in interface IUsagePlan.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IUsagePlan.Jsii$Default

Parameters:

policy - This parameter is required.

addApiKey

@Stability(Stable)
public final void addApiKey(@NotNull
 IApiKeyRef apiKey,
 @Nullable
 AddApiKeyOptions options)

Adds an ApiKey.

Specified by:

addApiKey in interface IUsagePlan

Specified by:

addApiKey in interface IUsagePlan.Jsii$Default

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)
public final void addApiKey(@NotNull
 IApiKeyRef 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.