Package software.amazon.awscdk.services.apigateway

Interface IRestApi.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IRestApi, IRestApiRef, IRestApiRef.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IRestApi.Jsii$Proxy
Enclosing interface:
IRestApi
@Internal public static interface IRestApi.Jsii$Default extends IRestApi, IResource.Jsii$Default, IRestApiRef.Jsii$Default
Internal default implementation for IRestApi.

  • Method Details

    • getRestApiId

      @Stability(Stable) @NotNull default String getRestApiId()
      The ID of this API Gateway RestApi.
      Specified by:
      getRestApiId in interface IRestApi

    • getRestApiName

      @Stability(Stable) @NotNull default String getRestApiName()
      The name of this API Gateway RestApi.
      Specified by:
      getRestApiName in interface IRestApi

    • getRestApiRootResourceId

      @Stability(Stable) @NotNull default String getRestApiRootResourceId()
      The resource ID of the root resource.
      Specified by:
      getRestApiRootResourceId in interface IRestApi

    • getRoot

      @Stability(Stable) @NotNull default IResource getRoot()
      Represents the root resource ("/") of this API. Use it to define the API model:.

      api.root.addMethod('ANY', redirectToHomePage); // "ANY /" api.root.addResource('friends').addMethod('GET', getFriendsHandler); // "GET /friends"

      Specified by:
      getRoot in interface IRestApi

    • getLatestDeployment

      @Stability(Stable) @Nullable default Deployment getLatestDeployment()
      API Gateway deployment that represents the latest changes of the API.

      This resource will be automatically updated every time the REST API model changes. undefined when no deployment is configured.

      Specified by:
      getLatestDeployment in interface IRestApi

    • getDeploymentStage

      @Stability(Stable) @NotNull default Stage getDeploymentStage()
      API Gateway stage that points to the latest deployment (if defined).
      Specified by:
      getDeploymentStage in interface IRestApi

    • setDeploymentStage

      @Stability(Stable) default void setDeploymentStage(@NotNull Stage value)
      API Gateway stage that points to the latest deployment (if defined).
      Specified by:
      setDeploymentStage in interface IRestApi

    • arnForExecuteApi

      @Stability(Stable) @NotNull default String arnForExecuteApi(@Nullable String method, @Nullable String path, @Nullable String stage)
      Gets the "execute-api" ARN.

      Default: "*" returns the execute API ARN for all methods/resources in this API.

      Specified by:
      arnForExecuteApi in interface IRestApi
      Parameters:
      method - The method (default *).
      path - The resource path.
      stage - The stage (default *).
      Returns:
      The "execute-api" ARN.

    • arnForExecuteApi

      @Stability(Stable) @NotNull default String arnForExecuteApi(@Nullable String method, @Nullable String path)
      Gets the "execute-api" ARN.

      Default: "*" returns the execute API ARN for all methods/resources in this API.

      Specified by:
      arnForExecuteApi in interface IRestApi
      Parameters:
      method - The method (default *).
      path - The resource path.
      Returns:
      The "execute-api" ARN.

    • arnForExecuteApi

      @Stability(Stable) @NotNull default String arnForExecuteApi(@Nullable String method)
      Gets the "execute-api" ARN.

      Default: "*" returns the execute API ARN for all methods/resources in this API.

      Specified by:
      arnForExecuteApi in interface IRestApi
      Parameters:
      method - The method (default *).
      Returns:
      The "execute-api" ARN.

    • arnForExecuteApi

      @Stability(Stable) @NotNull default String arnForExecuteApi()
      Gets the "execute-api" ARN.

      Default: "*" returns the execute API ARN for all methods/resources in this API.

      Specified by:
      arnForExecuteApi in interface IRestApi
      Returns:
      The "execute-api" ARN.