CfnUsagePlanProps Struct
Properties for defining a CfnUsagePlan.
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
apiStagesoptionalIResolvable | IResolvable | CfnUsagePlan.ApiStageProperty[]api_stagesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ApiStageProperty]]]apiStagesoptionalIResolvableApiStagesoptionalIResolvableApiStagesoptionalinterface{}#The associated API stages of a usage plan.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description of a usage plan.
quotaoptionalIResolvable | CfnUsagePlan.QuotaSettingsPropertyquotaoptionaltyping.Union[IResolvable, QuotaSettingsProperty]quotaoptionalIResolvableQuotaoptionalIResolvableQuotaoptionalinterface{}#The target maximum number of permitted requests per a given unit time interval.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#The collection of tags.
Each tag element is associated with a given resource.
throttleoptionalIResolvable | CfnUsagePlan.ThrottleSettingsPropertythrottleoptionaltyping.Union[IResolvable, ThrottleSettingsProperty]throttleoptionalIResolvableThrottleoptionalIResolvableThrottleoptionalinterface{}#A map containing method level throttling information for API stage in a usage plan.
usagePlanNameoptionalstringusage_plan_nameoptionalstrusagePlanNameoptionalStringUsagePlanNameoptionalstringUsagePlanNameoptional*string#The name of a usage plan.