@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:58.193Z") public interface IRestApi extends IResource
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.
|
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).
|
applyRemovalPolicy, getEnv, getStack
getNode
java.lang.String getRestApiId()
java.lang.String getRestApiRootResourceId()
IResource getRoot()
api.root.addMethod('ANY', redirectToHomePage); // "ANY /" api.root.addResource('friends').addMethod('GET', getFriendsHandler); // "GET /friends"
default Deployment getLatestDeployment()
This resource will be automatically updated every time the REST API model changes.
undefined
when no deployment is configured.
Stage getDeploymentStage()
void setDeploymentStage(Stage value)
java.lang.String arnForExecuteApi(java.lang.String method, java.lang.String path, java.lang.String stage)
Default: "*" returns the execute API ARN for all methods/resources in this API.
method
- The method (default `*`).path
- The resource path.stage
- The stage (default `*`).java.lang.String arnForExecuteApi(java.lang.String method, java.lang.String path)
Default: "*" returns the execute API ARN for all methods/resources in this API.
method
- The method (default `*`).path
- The resource path.java.lang.String arnForExecuteApi(java.lang.String method)
Default: "*" returns the execute API ARN for all methods/resources in this API.
method
- The method (default `*`).java.lang.String arnForExecuteApi()
Default: "*" returns the execute API ARN for all methods/resources in this API.