CfnUsagePlanProps

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

Bases: object

__init__(*, api_stages=None, description=None, quota=None, tags=None, throttle=None, usage_plan_name=None)

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

Parameters
  • api_stages (Union[IResolvable, None, List[Union[IResolvable, ApiStageProperty]]]) – AWS::ApiGateway::UsagePlan.ApiStages.

  • description (Optional[str]) – AWS::ApiGateway::UsagePlan.Description.

  • quota (Union[IResolvable, None, QuotaSettingsProperty]) – AWS::ApiGateway::UsagePlan.Quota.

  • tags (Optional[List[CfnTag]]) – AWS::ApiGateway::UsagePlan.Tags.

  • throttle (Union[IResolvable, None, ThrottleSettingsProperty]) – AWS::ApiGateway::UsagePlan.Throttle.

  • usage_plan_name (Optional[str]) – AWS::ApiGateway::UsagePlan.UsagePlanName.

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

Attributes

api_stages

AWS::ApiGateway::UsagePlan.ApiStages.

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

Return type

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

description

AWS::ApiGateway::UsagePlan.Description.

see :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 :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota

Return type

Union[IResolvable, None, QuotaSettingsProperty]

tags

AWS::ApiGateway::UsagePlan.Tags.

see :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 :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle

Return type

Union[IResolvable, None, ThrottleSettingsProperty]

usage_plan_name

AWS::ApiGateway::UsagePlan.UsagePlanName.

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

Return type

Optional[str]