UsagePlan L2 construct
Example
declare const integration: apigateway.LambdaIntegration;
const api = new apigateway.RestApi(this, 'hello-api');
const v1 = api.root.addResource('v1');
const echo = v1.addResource('echo');
const echoMethod = echo.addMethod('GET', integration, { apiKeyRequired: true });
const plan = api.addUsagePlan('UsagePlan', {
name: 'Easy',
throttle: {
rateLimit: 10,
burstLimit: 2
}
});
const key = api.addApiKey('ApiKey');
plan.addApiKey(key);
# integration: apigateway.LambdaIntegration
api = apigateway.RestApi(self, "hello-api")
v1 = api.root.add_resource("v1")
echo = v1.add_resource("echo")
echo_method = echo.add_method("GET", integration, api_key_required=True)
plan = api.add_usage_plan("UsagePlan",
name="Easy",
throttle=apigateway.ThrottleSettings(
rate_limit=10,
burst_limit=2
)
)
key = api.add_api_key("ApiKey")
plan.add_api_key(key)
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);
// Install: dotnet add package Amazon.CDK.Lib
LambdaIntegration integration;
var api = new RestApi(this, "hello-api");
var v1 = api.Root.AddResource("v1");
var echo = v1.AddResource("echo");
var echoMethod = echo.AddMethod("GET", integration, new MethodOptions { ApiKeyRequired = true });
var plan = api.AddUsagePlan("UsagePlan", new UsagePlanProps {
Name = "Easy",
Throttle = new ThrottleSettings {
RateLimit = 10,
BurstLimit = 2
}
});
var key = api.AddApiKey("ApiKey");
plan.AddApiKey(key);
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var integration LambdaIntegration
api := apigateway.NewRestApi(this, jsii.String("hello-api"))
v1 := api.Root.AddResource(jsii.String("v1"))
echo := v1.AddResource(jsii.String("echo"))
echoMethod := echo.AddMethod(jsii.String("GET"), integration, &MethodOptions{
ApiKeyRequired: jsii.Boolean(true),
})
plan := api.AddUsagePlan(jsii.String("UsagePlan"), &UsagePlanProps{
Name: jsii.String("Easy"),
Throttle: &ThrottleSettings{
RateLimit: jsii.Number(10),
BurstLimit: jsii.Number(2),
},
})
key := api.AddApiKey(jsii.String("ApiKey"))
plan.addApiKey(key)
Initializer
new UsagePlan(scope: Construct, id: string, props?: UsagePlanProps)
UsagePlan(scope: Construct, id: str, props: typing.Optional[UsagePlanProps] = None)
new UsagePlan(Construct scope, String id, UsagePlanProps props)
new UsagePlan(Construct scope, string id, UsagePlanProps? props = null)
NewUsagePlan(Scope Construct, Id *string, Props UsagePlanProps)
Construct Props
apiStagesUsagePlanPerApiStage[]api_stagestyping.List[UsagePlanPerApiStage]apiStagesList<UsagePlanPerApiStage>ApiStagesUsagePlanPerApiStage[]ApiStages*[]UsagePlanPerApiStage= none#throttleThrottleSettingsthrottleThrottleSettingsthrottleThrottleSettingsThrottleThrottleSettingsThrottleThrottleSettings= none#Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#usagePlanRefUsagePlanReferenceusage_plan_refUsagePlanReferenceusagePlanRefUsagePlanReferenceUsagePlanRefUsagePlanReferenceUsagePlanRefUsagePlanReferencerequired#Methods
addApiKey(apiKey: IApiKeyRef, options?: AddApiKeyOptions): voiddef add_api_key(self, api_key: IApiKeyRef, options: typing.Optional[AddApiKeyOptions] = None) -> Nonepublic void addApiKey(IApiKeyRef apiKey, AddApiKeyOptions options)public void AddApiKey(IApiKeyRef apiKey, AddApiKeyOptions? options = null)func AddApiKey(ApiKey IApiKeyRef, Options AddApiKeyOptions)#2 parameters
Parameters
apiKeyapi_keyapiKeyapiKeyApiKey— the api key to associate with this usage plan.optionsoptionsoptionsoptionsOptions— options that control the behaviour of this method.
addApiStage(apiStage: UsagePlanPerApiStage): voiddef add_api_stage(self, api_stage: UsagePlanPerApiStage) -> Nonepublic void addApiStage(UsagePlanPerApiStage apiStage)public void AddApiStage(UsagePlanPerApiStage apiStage)func AddApiStage(ApiStage UsagePlanPerApiStage)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromUsagePlanId(scope: Construct, id: string, usagePlanId: string): IUsagePlan@staticmethod def from_usage_plan_id(scope: Construct, id: str, usage_plan_id: str) -> IUsagePlanpublic static IUsagePlan fromUsagePlanId(Construct scope, String id, String usagePlanId)public static IUsagePlan FromUsagePlanId(Construct scope, string id, string usagePlanId)func FromUsagePlanId(Scope Construct, Id *string, UsagePlanId *string) IUsagePlanstatic#3 parameters
Parameters
scopescopescopescopeScope— the construct that will "own" the imported usage plan.ididididId— the id of the imported usage plan in the construct tree.usagePlanIdusage_plan_idusagePlanIdusagePlanIdUsagePlanId— the id of an existing usage plan.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.