software.amazon.awscdk.services.apigateway

Interface IRestApi

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IRestApi.Jsii$Default

All Known Implementing Classes:

IRestApi.Jsii$Proxy, LambdaRestApi, RestApi, RestApiBase, SpecRestApi, StepFunctionsRestApi

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:58.193Z")
public interface IRestApi
extends IResource

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	arnForExecuteApi() Gets the "execute-api" ARN.
java.lang.String	arnForExecuteApi(java.lang.String method) Gets the "execute-api" ARN.
java.lang.String	arnForExecuteApi(java.lang.String method, java.lang.String path) Gets the "execute-api" ARN.
java.lang.String	arnForExecuteApi(java.lang.String method, java.lang.String path, java.lang.String stage) Gets the "execute-api" ARN.
Stage	getDeploymentStage() API Gateway stage that points to the latest deployment (if defined).
default Deployment	getLatestDeployment() API Gateway deployment that represents the latest changes of the API.
java.lang.String	getRestApiId() The ID of this API Gateway RestApi.
java.lang.String	getRestApiRootResourceId() The resource ID of the root resource.
IResource	getRoot() Represents the root resource ("/") of this API.
void	setDeploymentStage(Stage value) API Gateway stage that points to the latest deployment (if defined).

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Method Detail

getRestApiId

java.lang.String getRestApiId()

The ID of this API Gateway RestApi.

getRestApiRootResourceId

java.lang.String getRestApiRootResourceId()

The resource ID of the root resource.

getRoot

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"

getLatestDeployment

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.

getDeploymentStage

Stage getDeploymentStage()

API Gateway stage that points to the latest deployment (if defined).

setDeploymentStage

void setDeploymentStage(Stage value)

API Gateway stage that points to the latest deployment (if defined).

arnForExecuteApi

java.lang.String arnForExecuteApi(java.lang.String method,
                                  java.lang.String path,
                                  java.lang.String stage)

Gets the "execute-api" ARN.

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

Parameters:

method - The method (default `*`).

path - The resource path.

stage - The stage (default `*`).

Returns:

The "execute-api" ARN.

arnForExecuteApi

java.lang.String arnForExecuteApi(java.lang.String method,
                                  java.lang.String path)

Gets the "execute-api" ARN.

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

Parameters:

method - The method (default `*`).

path - The resource path.

Returns:

The "execute-api" ARN.

arnForExecuteApi

java.lang.String arnForExecuteApi(java.lang.String method)

Gets the "execute-api" ARN.

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

Parameters:

method - The method (default `*`).

Returns:

The "execute-api" ARN.

arnForExecuteApi

java.lang.String arnForExecuteApi()

Gets the "execute-api" ARN.

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

Returns:

The "execute-api" ARN.