Class CfnUsagePlanProps
- Namespace
- Amazon.CDK.AWS.APIGateway
- Assembly
- Amazon.CDK.AWS.APIGateway.dll
Properties for defining a CfnUsagePlan
.
public class CfnUsagePlanProps : ICfnUsagePlanProps
- Inheritance
-
CfnUsagePlanProps
- Implements
- Inherited Members
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
var cfnUsagePlanProps = new CfnUsagePlanProps {
ApiStages = new [] { new ApiStageProperty {
ApiId = "apiId",
Stage = "stage",
Throttle = new Dictionary<string, object> {
{ "throttleKey", new ThrottleSettingsProperty {
BurstLimit = 123,
RateLimit = 123
} }
}
} },
Description = "description",
Quota = new QuotaSettingsProperty {
Limit = 123,
Offset = 123,
Period = "period"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Throttle = new ThrottleSettingsProperty {
BurstLimit = 123,
RateLimit = 123
},
UsagePlanName = "usagePlanName"
};
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html
ExampleMetadata: fixture=_generated
Constructors
CfnUsagePlanProps()
public CfnUsagePlanProps()
Properties
ApiStages
The associated API stages of a usage plan.
public object? ApiStages { get; set; }
Property Value
Remarks
Description
The description of a usage plan.
public string? Description { get; set; }
Property Value
Remarks
Quota
The target maximum number of permitted requests per a given unit time interval.
public object? Quota { get; set; }
Property Value
Remarks
Tags
The collection of tags.
public ICfnTag[]? Tags { get; set; }
Property Value
- ICfnTag[]
Remarks
Each tag element is associated with a given resource.
Throttle
A map containing method level throttling information for API stage in a usage plan.
public object? Throttle { get; set; }
Property Value
Remarks
UsagePlanName
The name of a usage plan.
public string? UsagePlanName { get; set; }