Table of Contents

Interface ICfnUsagePlanProps

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

Properties for defining a CfnUsagePlan.

public interface ICfnUsagePlanProps

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

Properties

ApiStages

The associated API stages of a usage plan.

object? ApiStages { get; }

Property Value

object

Remarks

Description

The description of a usage plan.

string? Description { get; }

Property Value

string

Remarks

Quota

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

object? Quota { get; }

Property Value

object

Remarks

Tags

The collection of tags.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

Throttle

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

object? Throttle { get; }

Property Value

object

Remarks

UsagePlanName

The name of a usage plan.

string? UsagePlanName { get; }

Property Value

string

Remarks