aws-cdk-lib.aws_apigateway.StageAttributes

interface StageAttributes

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.StageAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#StageAttributes
Javasoftware.amazon.awscdk.services.apigateway.StageAttributes
Pythonaws_cdk.aws_apigateway.StageAttributes
TypeScript (source)aws-cdk-lib » aws_apigateway » StageAttributes

The attributes of an imported Stage.

Example

declare const restApi: apigateway.IRestApi;
const importedStage = apigateway.Stage.fromStageAttributes(this, 'imported-stage', {
  stageName: 'myStageName',
  restApi,
});

importedStage.addApiKey('MyApiKey');

Properties

NameTypeDescription
restApiIRestApiThe RestApi that the stage belongs to.
stageNamestringThe name of the stage.

restApi

Type: IRestApi

The RestApi that the stage belongs to.


stageName

Type: string

The name of the stage.