aws-cdk-lib.aws_apigateway.CfnUsagePlanProps

interface CfnUsagePlanProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnUsagePlanProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnUsagePlanProps
Javasoftware.amazon.awscdk.services.apigateway.CfnUsagePlanProps
Pythonaws_cdk.aws_apigateway.CfnUsagePlanProps
TypeScript aws-cdk-lib » 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 { 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

NameTypeDescription
apiStages?IResolvable | IResolvable | ApiStageProperty[]The associated API stages of a usage plan.
description?stringThe description of a usage plan.
quota?IResolvable | QuotaSettingsPropertyThe target maximum number of permitted requests per a given unit time interval.
tags?CfnTag[]The collection of tags.
throttle?IResolvable | ThrottleSettingsPropertyA map containing method level throttling information for API stage in a usage plan.
usagePlanName?stringThe 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.