IUsagePlan

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

Bases: IResource, 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

apply_removal_policy(policy)

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

Parameters:

policy (RemovalPolicy) –

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.

node

The tree node.

stack

The stack in which this resource is defined.

usage_plan_id

Id of the usage plan.

Attribute:

true