Class IUsagePlan.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IUsagePlan
,IUsagePlan.Jsii$Default
,IUsagePlanRef
,IUsagePlanRef.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
-
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.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.services.apigateway.IUsagePlanRef
IUsagePlanRef.Jsii$Default, IUsagePlanRef.Jsii$Proxy
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal 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
Id of the usage plan.final UsagePlanReference
(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 interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
- Specified by:
getNode
in interfaceIUsagePlan
- Specified by:
getNode
in interfaceIUsagePlan.Jsii$Default
- Specified by:
getNode
in interfaceIUsagePlanRef.Jsii$Default
-
getEnv
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
- Specified by:
getEnv
in interfaceIUsagePlan.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
- Specified by:
getStack
in interfaceIUsagePlan.Jsii$Default
-
getUsagePlanRef
(experimental) A reference to a UsagePlan resource.- Specified by:
getUsagePlanRef
in interfaceIUsagePlan.Jsii$Default
- Specified by:
getUsagePlanRef
in interfaceIUsagePlanRef
- Specified by:
getUsagePlanRef
in interfaceIUsagePlanRef.Jsii$Default
-
getUsagePlanId
Id of the usage plan.- Specified by:
getUsagePlanId
in interfaceIUsagePlan
- Specified by:
getUsagePlanId
in interfaceIUsagePlan.Jsii$Default
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIUsagePlan.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 interfaceIUsagePlan
- Specified by:
addApiKey
in interfaceIUsagePlan.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
Adds an ApiKey.- Specified by:
addApiKey
in interfaceIUsagePlan
- Parameters:
apiKey
- the api key to associate with this usage plan. This parameter is required.
-