CfnUsagePlanProps

class aws_cdk.aws_apigateway.CfnUsagePlanProps(*, api_stages=None, description=None, quota=None, tags=None, throttle=None, usage_plan_name=None)

Bases: object

Properties for defining a AWS::ApiGateway::UsagePlan.

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html

Attributes

api_stages

AWS::ApiGateway::UsagePlan.ApiStages.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages

Return type

Union[IResolvable, List[Union[IResolvable, ApiStageProperty]], None]

description

AWS::ApiGateway::UsagePlan.Description.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description

Return type

Optional[str]

quota

AWS::ApiGateway::UsagePlan.Quota.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota

Return type

Union[IResolvable, QuotaSettingsProperty, None]

tags

AWS::ApiGateway::UsagePlan.Tags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags

Return type

Optional[List[CfnTag]]

throttle

AWS::ApiGateway::UsagePlan.Throttle.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle

Return type

Union[IResolvable, ThrottleSettingsProperty, None]

usage_plan_name

AWS::ApiGateway::UsagePlan.UsagePlanName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname

Return type

Optional[str]