# CfnUsagePlanProps

Properties for defining a `CfnUsagePlan`.

Extends: CfnUsagePlanProps
Used as props by: CfnUsagePlan

- Source: Generated code

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnUsagePlanProps: apigateway.CfnUsagePlanProps = {
  apiStages: [{
    apiId: 'apiId',
    stage: 'stage',
    throttle: {
      throttleKey: {
        burstLimit: 123,
        rateLimit: 123,
      },
    },
  }],
  description: 'description',
  quota: {
    limit: 123,
    offset: 123,
    period: 'period',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  throttle: {
    burstLimit: 123,
    rateLimit: 123,
  },
  usagePlanName: 'usagePlanName',
};
```

## Properties

- `apiStages`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUsagePlan.ApiStageProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CfnUsagePlan.ApiStageProperty.html)[] — The associated API stages of a usage plan.

- `description`: string — The description of a usage plan.

- `quota`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUsagePlan.QuotaSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CfnUsagePlan.QuotaSettingsProperty.html) — The target maximum number of permitted requests per a given unit time interval.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The collection of tags.

  Each tag element is associated with a given resource.

- `throttle`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUsagePlan.ThrottleSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CfnUsagePlan.ThrottleSettingsProperty.html) — A map containing method level throttling information for API stage in a usage plan.

- `usagePlanName`: string — The name of a usage plan.