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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IUsagePlanRef

Implemented by UsagePlan

Obtainable from UsagePlan.fromUsagePlanId()

A UsagePlan, either managed by this CDK app, or imported.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
usagePlanId	string	Id of the usage plan.
usagePlanRef🔹	UsagePlanReference	A reference to a UsagePlan resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

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.

---

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.

---

usagePlanRef🔹

Type: UsagePlanReference

A reference to a UsagePlan resource.

Methods

Name	Description
addApiKey(apiKey, options?)	Adds an ApiKey.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
with(...mixins)	Applies one or more mixins to this construct.

---

addApiKey(apiKey, options?)

public addApiKey(apiKey: IApiKeyRef, options?: AddApiKeyOptions): void

Parameters

• apiKey IApiKeyRef — the api key to associate with this usage plan.
• options AddApiKeyOptions — options that control the behaviour of this method.

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).

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

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.