UsagePlan

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

Bases: Resource

ExampleMetadata:

infused

Example:

# integration: apigateway.LambdaIntegration


api = apigateway.RestApi(self, "hello-api")

v1 = api.root.add_resource("v1")
echo = v1.add_resource("echo")
echo_method = echo.add_method("GET", integration, api_key_required=True)

plan = api.add_usage_plan("UsagePlan",
    name="Easy",
    throttle=apigateway.ThrottleSettings(
        rate_limit=10,
        burst_limit=2
    )
)

key = api.add_api_key("ApiKey")
plan.add_api_key(key)
Parameters:

  • scope (Construct) –

  • id (str) –

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

  • api_stages (Optional[Sequence[Union[UsagePlanPerApiStage, Dict[str, Any]]]]) – 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 (Union[QuotaSettings, Dict[str, Any], None]) – Number of requests clients can make in a given time period. Default: none

  • throttle (Union[ThrottleSettings, Dict[str, Any], None]) – 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[Union[ThrottlingPerMethod, Dict[str, Any]]]]) – 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.DESTROY), 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.

node

The construct tree node associated with this construct.

stack

The stack in which this resource is defined.

usage_plan_id

Id of the usage plan.

Attribute:

true

Static Methods

classmethod from_usage_plan_id(scope, id, usage_plan_id)

Import an externally defined usage plan using its ARN.

Parameters:

  • scope (Construct) – the construct that will “own” the imported usage plan.

  • id (str) – the id of the imported usage plan in the construct tree.

  • usage_plan_id (str) – the id of an existing usage plan.

Return type:

IUsagePlan

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