UsagePlan

class aws_cdk.aws_apigateway.UsagePlan(scope, id, *, api_key=None, api_stages=None, description=None, name=None, quota=None, throttle=None)

Bases: aws_cdk.core.Resource

Parameters
  • scope (Construct) –

  • id (str) –

  • api_key (Optional[IApiKey]) – (deprecated) ApiKey to be associated with the usage plan. Default: none

  • api_stages (Optional[Sequence[UsagePlanPerApiStage]]) – API Stages to be associated with the usage plan. Default: none

  • description (Optional[str]) – Represents usage plan purpose. Default: none

  • name (Optional[str]) – Name for this usage plan. Default: none

  • quota (Optional[QuotaSettings]) – Number of requests clients can make in a given time period. Default: none

  • throttle (Optional[ThrottleSettings]) – Overall throttle settings for the API. Default: none

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

add_api_stage(*, api=None, stage=None, throttle=None)

Adds an apiStage.

Parameters
  • api (Optional[IRestApi]) – Default: none

  • stage (Optional[Stage]) – [disable-awslint:ref-via-interface]. Default: none

  • throttle (Optional[Sequence[ThrottlingPerMethod]]) – Default: none

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.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

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 associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

usage_plan_id

true

Type

attribute

Return type

str

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool