software.amazon.awscdk.services.apigateway

Interface IUsagePlan.Jsii$Default

All Superinterfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IUsagePlan

All Known Implementing Classes:

IUsagePlan.Jsii$Proxy

Enclosing interface:

IUsagePlan

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) Adds an ApiKey.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default ConstructNode	getNode() The construct tree node for this construct.
default Stack	getStack() The stack in which this resource is defined.
default java.lang.String	getUsagePlanId() Id of the usage plan.

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

addApiKey

Method Detail

getNode

default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

default ResourceEnvironment 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 interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getUsagePlanId

default java.lang.String getUsagePlanId()

Id of the usage plan.

Specified by:

getUsagePlanId in interface IUsagePlan

applyRemovalPolicy

default void applyRemovalPolicy(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

Parameters:

policy - This parameter is required.

addApiKey

default void addApiKey(IApiKey apiKey,
                       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.