Package software.amazon.awscdk.services.apigateway

Interface IStage

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IStage.Jsii$Default
All Known Implementing Classes:
IStage.Jsii$Proxy, Stage, StageBase
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:02.599Z") @Stability(Stable) public interface IStage extends software.amazon.jsii.JsiiSerializable, IResource
Represents an APIGateway Stage.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IStage.Jsii$Default
    Internal default implementation for IStage.
    static final class 
    IStage.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    IApiKey
    addApiKey(String id)
    Add an ApiKey to this Stage.
    IApiKey
    addApiKey(String id, ApiKeyOptions options)
    Add an ApiKey to this Stage.
    IRestApi
    getRestApi()
    RestApi to which this stage is associated.
    String
    getStageName()
    Name of this stage.

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getRestApi

      @Stability(Stable) @NotNull IRestApi getRestApi()
      RestApi to which this stage is associated.

    • getStageName

      @Stability(Stable) @NotNull String getStageName()
      Name of this stage.

    • addApiKey

      @Stability(Stable) @NotNull IApiKey addApiKey(@NotNull String id, @Nullable ApiKeyOptions options)
      Add an ApiKey to this Stage.

      Parameters:
      id - This parameter is required.
      options -

    • addApiKey

      @Stability(Stable) @NotNull IApiKey addApiKey(@NotNull String id)
      Add an ApiKey to this Stage.

      Parameters:
      id - This parameter is required.