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, IUsagePlan, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.242Z")
 @Stability(value=Stable)
public class UsagePlan
extends Resource
implements IUsagePlan

Example:

 LambdaIntegration integration;
 RestApi api = new RestApi(this, "hello-api");
 Resource v1 = api.root.addResource("v1");
 Resource echo = v1.addResource("echo");
 Method echoMethod = echo.addMethod("GET", integration, MethodOptions.builder().apiKeyRequired(true).build());
 UsagePlan plan = api.addUsagePlan("UsagePlan", UsagePlanProps.builder()
         .name("Easy")
         .throttle(ThrottleSettings.builder()
                 .rateLimit(10)
                 .burstLimit(2)
                 .build())
         .build());
 IApiKey key = api.addApiKey("ApiKey");
 plan.addApiKey(key);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsagePlan.Builder 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.services.apigateway.IUsagePlan

IUsagePlan.Jsii$Default, IUsagePlan.Jsii$Proxy

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) Adds an ApiKey.
void	addApiKey(IApiKey apiKey, AddApiKeyOptions options) Adds an ApiKey.
void	addApiStage(UsagePlanPerApiStage apiStage) Adds an apiStage.
static IUsagePlan	fromUsagePlanId(software.constructs.Construct scope, String id, String usagePlanId) Import an externally defined usage plan using its ARN.
String	getUsagePlanId() Id of the usage plan.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, 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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

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=Stable)
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=Stable)
public UsagePlan(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromUsagePlanId

@Stability(value=Stable)
 @NotNull
public static IUsagePlan fromUsagePlanId(@NotNull
                                                                            software.constructs.Construct scope,
                                                                            @NotNull
                                                                            String id,
                                                                            @NotNull
                                                                            String usagePlanId)

Import an externally defined usage plan using its ARN.

Parameters:

scope - the construct that will "own" the imported usage plan. This parameter is required.

id - the id of the imported usage plan in the construct tree. This parameter is required.

usagePlanId - the id of an existing usage plan. This parameter is required.

addApiKey

@Stability(value=Stable)
public void addApiKey(@NotNull
                                               IApiKey apiKey,
                                               @Nullable
                                               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.

addApiKey

@Stability(value=Stable)
public void addApiKey(@NotNull
                                               IApiKey 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.

addApiStage

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

Adds an apiStage.

Parameters:

apiStage - This parameter is required.

getUsagePlanId

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

Id of the usage plan.

Specified by:

getUsagePlanId in interface IUsagePlan