interface IStage

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

Implemented by Stage

Obtainable from Stage.fromStageAttributes()

Represents an APIGateway Stage.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
restApi	IRestApi	RestApi to which this stage is associated.
stack	Stack	The stack in which this resource is defined.
stageName	string	Name of this stage.
stageRef🔹	StageReference	A reference to a Stage resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

restApi

Type: IRestApi

RestApi to which this stage is associated.

---

stack

Type: Stack

The stack in which this resource is defined.

---

stageName

Type: string

Name of this stage.

---

stageRef🔹

Type: StageReference

A reference to a Stage resource.

Methods

Name	Description
addApiKey(id, options?)	Add an ApiKey to this Stage.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

addApiKey(id, options?)

public addApiKey(id: string, options?: ApiKeyOptions): IApiKey

Parameters

• id string
• options ApiKeyOptions

Returns

• IApiKey

Add an ApiKey to this Stage.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).