interface IUsagePlan
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.IUsagePlan |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#IUsagePlan |
 Java | software.amazon.awscdk.services.apigateway.IUsagePlan |
 Python | aws_cdk.aws_apigateway.IUsagePlan |
 TypeScript (source) | aws-cdk-lib » aws_apigateway » IUsagePlan |
Implemented by
Usage
Obtainable from
Usage.fromUsagePlanId()
A UsagePlan, either managed by this CDK app, or imported.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| usage | string | Id of the usage plan. |
env
Type:
Resource
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.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
usagePlanId
Type:
string
Id of the usage plan.
Methods
| Name | Description |
|---|---|
| add | Adds an ApiKey. |
| apply | Apply the given removal policy to this resource. |
addApiKey(apiKey, options?)
public addApiKey(apiKey: IApiKey, options?: AddApiKeyOptions): void
Parameters
- apiKey
IApi— the api key to associate with this usage plan.Key - options
Add— options that control the behaviour of this method.Api Key Options
Adds an ApiKey.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
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).