interface ApiStageProperty

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway.CfnUsagePlanPropsMixin.ApiStageProperty`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsapigateway#CfnUsagePlanPropsMixin_ApiStageProperty`
Java	`software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnUsagePlanPropsMixin.ApiStageProperty`
Python	`aws_cdk.cfn_property_mixins.aws_apigateway.CfnUsagePlanPropsMixin.ApiStageProperty`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_apigateway` » `CfnUsagePlanPropsMixin` » `ApiStageProperty`

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

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/cfn-property-mixins';
const apiStageProperty: apigateway.CfnUsagePlanPropsMixin.ApiStageProperty = {
  apiId: 'apiId',
  stage: 'stage',
  throttle: {
    throttleKey: {
      burstLimit: 123,
      rateLimit: 123,
    },
  },
};

Properties

Name	Type	Description
apiId?	`string \|` `IRestApiRef`	API Id of the associated API stage in a usage plan.
stage?	`string \|` `IStageRef`	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 | IRestApiRef (optional)

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

stage?

Type: string | IStageRef (optional)

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

throttle?

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

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

AWS CDK