interface IUsagePlanRef 🔹

Language	Type name
.NET	Amazon.CDK.Interfaces.APIGateway.IUsagePlanRef
Go	github.com/aws/aws-cdk-go/awscdk/v2/interfaces/awsapigateway#IUsagePlanRef
Java	software.amazon.awscdk.interfaces.apigateway.IUsagePlanRef
Python	aws_cdk.interfaces.aws_apigateway.IUsagePlanRef
TypeScript	aws-cdk-lib » interfaces » aws_apigateway » IUsagePlanRef

Implements IDependable, IConstruct, IEnvironmentAware

Implemented by CfnUsagePlan, UsagePlan, UsagePlan

Obtainable from CfnUsagePlan.fromUsagePlanId()

Indicates that this resource can be referenced as a UsagePlan.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
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.

---

usagePlanRef🔹

Type: UsagePlanReference

A reference to a UsagePlan resource.

Methods

Name	Description
with(...mixins)🔹	Applies one or more mixins to this construct.

---

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.