interface CfnUsagePlanProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnUsagePlanProps
Java	software.amazon.awscdk.services.apigateway.CfnUsagePlanProps
Python	aws_cdk.aws_apigateway.CfnUsagePlanProps
TypeScript	@aws-cdk/aws-apigateway » CfnUsagePlanProps

Properties for defining a CfnUsagePlan.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';
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

Name	Type	Description
apiStages?	IResolvable | IResolvable | ApiStageProperty[]	The associated API stages of a usage plan.
description?	string	The description of a usage plan.
quota?	IResolvable | QuotaSettingsProperty	The target maximum number of permitted requests per a given unit time interval.
tags?	CfnTag[]	The collection of tags.
throttle?	IResolvable | ThrottleSettingsProperty	A map containing method level throttling information for API stage in a usage plan.
usagePlanName?	string	The name of a usage plan.

---

apiStages?

Type: IResolvable | IResolvable | ApiStageProperty[] (optional)

The associated API stages of a usage plan.

---

description?

Type: string (optional)

The description of a usage plan.

---

quota?

Type: IResolvable | QuotaSettingsProperty (optional)

The target maximum number of permitted requests per a given unit time interval.

---

tags?

Type: CfnTag[] (optional)

The collection of tags.

Each tag element is associated with a given resource.

---

throttle?

Type: IResolvable | ThrottleSettingsProperty (optional)

A map containing method level throttling information for API stage in a usage plan.

---

usagePlanName?

Type: string (optional)

The name of a usage plan.