IUsagePlan

class aws_cdk.aws_apigateway.IUsagePlan(*args, **kwds)

Bases: aws_cdk.core.IResource, typing_extensions.Protocol

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

Methods

add_api_key(api_key, *, override_logical_id=None)

Adds an ApiKey.

Parameters
  • api_key (IApiKey) – the api key to associate with this usage plan.

  • override_logical_id (Optional[str]) – Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource. Default: - autogenerated by the CDK

Return type

None

Attributes

env

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.

Return type

ResourceEnvironment

node

The construct tree node for this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

usage_plan_id

Id of the usage plan.

Attribute

true

Return type

str