software.amazon.awscdk.services.apigateway

Class RestApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.RestApiBase

software.amazon.awscdk.services.apigateway.RestApi

All Implemented Interfaces:

IResource, IRestApi, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

LambdaRestApi, StepFunctionsRestApi

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.209Z")
 @Stability(value=Stable)
public class RestApi
extends RestApiBase

Represents a REST API in Amazon API Gateway.

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));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestApi.Builder A fluent builder for RestApi.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IRestApi

IRestApi.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	RestApi(software.constructs.Construct scope, String id)
	RestApi(software.constructs.Construct scope, String id, RestApiProps props)
protected	RestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RestApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Model	addModel(String id, ModelOptions props) Adds a new model.
RequestValidator	addRequestValidator(String id, RequestValidatorOptions props) Adds a new request validator.
static IRestApi	fromRestApiAttributes(software.constructs.Construct scope, String id, RestApiAttributes attrs) Import an existing RestApi that can be configured with additional Methods and Resources.
static IRestApi	fromRestApiId(software.constructs.Construct scope, String id, String restApiId) Import an existing RestApi.
List<Method>	getMethods() The list of methods bound to this RestApi.
String	getRestApiId() The ID of this API Gateway RestApi.
String	getRestApiRootResourceId() The resource ID of the root resource.
IResource	getRoot() Represents the root resource of this API endpoint ('/').
String	getUrl() The deployed root URL of this REST API.

Methods inherited from class software.amazon.awscdk.services.apigateway.RestApiBase

addApiKey, addApiKey, addDomainName, addGatewayResponse, addUsagePlan, addUsagePlan, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, 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

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

RestApi

protected RestApi(software.amazon.jsii.JsiiObjectRef objRef)

RestApi

protected RestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

RestApi

@Stability(value=Stable)
public RestApi(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @Nullable
                                        RestApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

RestApi

@Stability(value=Stable)
public RestApi(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromRestApiAttributes

@Stability(value=Stable)
 @NotNull
public static IRestApi fromRestApiAttributes(@NotNull
                                                                                software.constructs.Construct scope,
                                                                                @NotNull
                                                                                String id,
                                                                                @NotNull
                                                                                RestApiAttributes attrs)

Import an existing RestApi that can be configured with additional Methods and Resources.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

fromRestApiId

@Stability(value=Stable)
 @NotNull
public static IRestApi fromRestApiId(@NotNull
                                                                        software.constructs.Construct scope,
                                                                        @NotNull
                                                                        String id,
                                                                        @NotNull
                                                                        String restApiId)

Import an existing RestApi.

Parameters:

scope - This parameter is required.

id - This parameter is required.

restApiId - This parameter is required.

addModel

@Stability(value=Stable)
 @NotNull
public Model addModel(@NotNull
                                                         String id,
                                                         @NotNull
                                                         ModelOptions props)

Adds a new model.

Parameters:

id - This parameter is required.

props - This parameter is required.

addRequestValidator

@Stability(value=Stable)
 @NotNull
public RequestValidator addRequestValidator(@NotNull
                                                                               String id,
                                                                               @NotNull
                                                                               RequestValidatorOptions props)

Adds a new request validator.

Parameters:

id - This parameter is required.

props - This parameter is required.

getMethods

@Stability(value=Stable)
 @NotNull
public List<Method> getMethods()

The list of methods bound to this RestApi.

getRestApiId

@Stability(value=Stable)
 @NotNull
public String getRestApiId()

The ID of this API Gateway RestApi.

Specified by:

getRestApiId in interface IRestApi

Specified by:

getRestApiId in class RestApiBase

getRestApiRootResourceId

@Stability(value=Stable)
 @NotNull
public String getRestApiRootResourceId()

The resource ID of the root resource.

Specified by:

getRestApiRootResourceId in interface IRestApi

Specified by:

getRestApiRootResourceId in class RestApiBase

getRoot

@Stability(value=Stable)
 @NotNull
public IResource getRoot()

Represents the root resource of this API endpoint ('/').

Resources and Methods are added to this resource.

Specified by:

getRoot in interface IRestApi

Specified by:

getRoot in class RestApiBase

getUrl

@Stability(value=Stable)
 @NotNull
public String getUrl()

The deployed root URL of this REST API.