aws-cdk-lib.aws_apigateway.CfnUsagePlanProps

CfnUsagePlanProps Struct

Properties for defining a CfnUsagePlan.

CfnUsagePlanProps

used as props by

• CfnUsagePlan

Source

Generated code

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

apiStagesIResolvable | IResolvable | CfnUsagePlan.ApiStageProperty[]api_stagestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ApiStageProperty]]]apiStagesIResolvableApiStagesIResolvableApiStagesinterface{}#

The associated API stages of a usage plan.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description of a usage plan.

quotaIResolvable | CfnUsagePlan.QuotaSettingsPropertyquotatyping.Union[IResolvable, QuotaSettingsProperty]quotaIResolvableQuotaIResolvableQuotainterface{}#

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

The collection of tags.

Each tag element is associated with a given resource.

throttleIResolvable | CfnUsagePlan.ThrottleSettingsPropertythrottletyping.Union[IResolvable, ThrottleSettingsProperty]throttleIResolvableThrottleIResolvableThrottleinterface{}#

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

usagePlanNamestringusage_plan_namestrusagePlanNameStringUsagePlanNamestringUsagePlanName*string#

The name of a usage plan.