aws-cdk-lib.aws_apigateway.IStage

interface IStage

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

Implemented by Stage

Obtainable from Stage.fromStageAttributes()

Represents an APIGateway Stage.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
restApiIRestApiRestApi to which this stage is associated.
stackStackThe stack in which this resource is defined.
stageNamestringName of this stage.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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.

Methods

NameDescription
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).