aws-cdk-lib.aws_apigateway.CfnUsagePlan.ApiStageProperty

interface ApiStageProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnUsagePlan.ApiStageProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnUsagePlan_ApiStageProperty
Javasoftware.amazon.awscdk.services.apigateway.CfnUsagePlan.ApiStageProperty
Pythonaws_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.

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

NameTypeDescription
apiId?stringAPI Id of the associated API stage in a usage plan.
stage?stringAPI 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.


stage?

Type: string (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.