interface ApiStageProperty

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnUsagePlan.ApiStageProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnUsagePlan_ApiStageProperty
Java	software.amazon.awscdk.services.apigateway.CfnUsagePlan.ApiStageProperty
Python	aws_cdk.aws_apigateway.CfnUsagePlan.ApiStageProperty
TypeScript	aws-cdk-lib » aws_apigateway » CfnUsagePlan » ApiStageProperty

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

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

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 apiStageProperty: apigateway.CfnUsagePlan.ApiStageProperty = {
  apiId: 'apiId',
  stage: 'stage',
  throttle: {
    throttleKey: {
      burstLimit: 123,
      rateLimit: 123,
    },
  },
};

Properties

Name	Type	Description
apiId?	string	API Id of the associated API stage in a usage plan.
stage?	string	API stage name of the associated API stage in a usage plan.
throttle?	IResolvable | { [string]: IResolvable | ThrottleSettingsProperty }	Map containing method level throttling information for API stage in a usage plan.

---

apiId?

Type: string (optional)

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

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

---

stage?

Type: string (optional)

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

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

---

throttle?

Type: IResolvable | { [string]: IResolvable | ThrottleSettingsProperty } (optional)

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

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