software.amazon.awscdk.services.apigateway

Class UsagePlan

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.UsagePlan

All Implemented Interfaces:

IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.904Z")
 @Stability(value=Experimental)
public class UsagePlan
extends Resource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsagePlan.Builder (experimental) A fluent builder for UsagePlan.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	UsagePlan(software.constructs.Construct scope, String id)
	UsagePlan(software.constructs.Construct scope, String id, UsagePlanProps props)
protected	UsagePlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UsagePlan(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addApiKey(IApiKey apiKey) (experimental) Adds an ApiKey.
void	addApiKey(IApiKey apiKey, AddApiKeyOptions options) (experimental) Adds an ApiKey.
void	addApiStage(UsagePlanPerApiStage apiStage) (experimental) Adds an apiStage.
String	getUsagePlanId()

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

UsagePlan

protected UsagePlan(software.amazon.jsii.JsiiObjectRef objRef)

UsagePlan

protected UsagePlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UsagePlan

@Stability(value=Experimental)
public UsagePlan(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @Nullable
                                                UsagePlanProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

UsagePlan

@Stability(value=Experimental)
public UsagePlan(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addApiKey

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

(experimental) Adds an ApiKey.

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(value=Experimental)
public void addApiKey(@NotNull
                                                     IApiKey apiKey)

(experimental) Adds an ApiKey.

Parameters:

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

addApiStage

@Stability(value=Experimental)
public void addApiStage(@NotNull
                                                       UsagePlanPerApiStage apiStage)

(experimental) Adds an apiStage.

Parameters:

apiStage - This parameter is required.

getUsagePlanId

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