@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-25T18:29:08.568Z") public class RestApi extends RestApiBase
Use addResource
and addMethod
to configure the API model.
By default, the API will automatically be deployed and accessible from a public endpoint.
Example:
StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine") .stateMachineType(StateMachineType.EXPRESS) .definition(Chain.start(new Pass(this, "Pass"))) .build(); RestApi api = RestApi.Builder.create(this, "Api") .restApiName("MyApi") .build(); api.root.addMethod("GET", StepFunctionsIntegration.startExecution(stateMachine));
Modifier and Type | Class and Description |
---|---|
static class |
RestApi.Builder
A fluent builder for
RestApi . |
IRestApi.Jsii$Default
Modifier | Constructor and Description |
---|---|
protected |
RestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
RestApi(software.amazon.jsii.JsiiObjectRef objRef) |
|
RestApi(software.constructs.Construct scope,
java.lang.String id) |
|
RestApi(software.constructs.Construct scope,
java.lang.String id,
RestApiProps props) |
Modifier and Type | Method and Description |
---|---|
Model |
addModel(java.lang.String id,
ModelOptions props)
Adds a new model.
|
RequestValidator |
addRequestValidator(java.lang.String id,
RequestValidatorOptions props)
Adds a new request validator.
|
static IRestApi |
fromRestApiAttributes(software.constructs.Construct scope,
java.lang.String id,
RestApiAttributes attrs)
Import an existing RestApi that can be configured with additional Methods and Resources.
|
static IRestApi |
fromRestApiId(software.constructs.Construct scope,
java.lang.String id,
java.lang.String restApiId)
Import an existing RestApi.
|
java.util.List<Method> |
getMethods()
The list of methods bound to this RestApi.
|
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 endpoint ('/').
|
java.lang.String |
getUrl()
The deployed root URL of this REST API.
|
protected java.util.List<java.lang.String> |
validate()
Performs validation of the REST API.
|
addApiKey, addApiKey, addDomainName, addGatewayResponse, addUsagePlan, addUsagePlan, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, configureCloudWatchRole, configureDeployment, getCloudWatchAccount, getDeploymentStage, getDomainName, getLatestDeployment, getRestApiName, metric, metric, metricCacheHitCount, metricCacheHitCount, metricCacheMissCount, metricCacheMissCount, metricClientError, metricClientError, metricCount, metricCount, metricIntegrationLatency, metricIntegrationLatency, metricLatency, metricLatency, metricServerError, metricServerError, setCloudWatchAccount, setDeploymentStage, urlForPath, urlForPath
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected RestApi(software.amazon.jsii.JsiiObjectRef objRef)
protected RestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public RestApi(software.constructs.Construct scope, java.lang.String id, RestApiProps props)
scope
- This parameter is required.id
- This parameter is required.props
- public RestApi(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public static IRestApi fromRestApiAttributes(software.constructs.Construct scope, java.lang.String id, RestApiAttributes attrs)
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.public static IRestApi fromRestApiId(software.constructs.Construct scope, java.lang.String id, java.lang.String restApiId)
scope
- This parameter is required.id
- This parameter is required.restApiId
- This parameter is required.public Model addModel(java.lang.String id, ModelOptions props)
id
- This parameter is required.props
- This parameter is required.public RequestValidator addRequestValidator(java.lang.String id, RequestValidatorOptions props)
id
- This parameter is required.props
- This parameter is required.protected java.util.List<java.lang.String> validate()
public java.util.List<Method> getMethods()
public java.lang.String getRestApiId()
getRestApiId
in interface IRestApi
getRestApiId
in class RestApiBase
public java.lang.String getRestApiRootResourceId()
getRestApiRootResourceId
in interface IRestApi
getRestApiRootResourceId
in class RestApiBase
public IResource getRoot()
Resources and Methods are added to this resource.
getRoot
in interface IRestApi
getRoot
in class RestApiBase
public java.lang.String getUrl()