Package software.amazon.awscdk.services.apigateway

Interface StageAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StageAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-05-07T19:18:42.190Z")
@Stability(Stable)
public interface StageAttributes
extends software.amazon.jsii.JsiiSerializable

The attributes of an imported Stage.

Example:

 IRestApi restApi;
 IStage importedStage = Stage.fromStageAttributes(this, "imported-stage", StageAttributes.builder()
         .stageName("myStageName")
         .restApi(restApi)
         .build());
 importedStage.addApiKey("MyApiKey");
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StageAttributes.Builder	A builder for StageAttributes
static final class	StageAttributes.Jsii$Proxy	An implementation for StageAttributes

Method Summary

Modifier and Type	Method	Description
static StageAttributes.Builder	builder()
IRestApi	getRestApi()	The RestApi that the stage belongs to.
String	getStageName()	The name of the stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRestApi

@Stability(Stable)
@NotNull
IRestApi getRestApi()

The RestApi that the stage belongs to.

getStageName

@Stability(Stable)
@NotNull
String getStageName()

The name of the stage.

builder

@Stability(Stable)
static StageAttributes.Builder builder()

Returns:

a StageAttributes.Builder of StageAttributes