Interface CfnUsagePlan.IApiStageProperty

API stage name of the associated API stage in a usage plan.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IApiStageProperty

Syntax (vb)

Public Interface IApiStageProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html

ExampleMetadata: fixture=_generated

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 apiStageProperty = new ApiStageProperty {
    ApiId = "apiId",
    Stage = "stage",
    Throttle = new Dictionary<string, object> {
        { "throttleKey", new ThrottleSettingsProperty {
            BurstLimit = 123,
            RateLimit = 123
        } }
    }
};

Synopsis

Properties

ApiId	API Id of the associated API stage in a usage plan.
Stage	API stage name of the associated API stage in a usage plan.
Throttle	Map containing method level throttling information for API stage in a usage plan.

Properties

ApiId

API Id of the associated API stage in a usage plan.

virtual string ApiId { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid

Stage

API stage name of the associated API stage in a usage plan.

virtual string Stage { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage

Throttle

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

virtual object Throttle { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-throttle