UsagePlan
- class aws_cdk.aws_apigateway.UsagePlan(scope, id, *, 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_stages (
Optional
[Sequence
[Union
[UsagePlanPerApiStage
,Dict
[str
,Any
]]]]) – API Stages to be associated with the usage plan. Default: nonedescription (
Optional
[str
]) – Represents usage plan purpose. Default: nonename (
Optional
[str
]) – Name for this usage plan. Default: nonequota (
Union
[QuotaSettings
,Dict
[str
,Any
],None
]) – Number of requests clients can make in a given time period. Default: nonethrottle (
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: nonestage (
Optional
[Stage
]) – [disable-awslint:ref-via-interface]. Default: nonethrottle (
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 tree node.
- 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:
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool