software.amazon.awscdk.services.apigateway

Class RestApiBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.RestApiBase

All Implemented Interfaces:

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

Direct Known Subclasses:

RestApi, SpecRestApi

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:46.084Z")
 @Stability(value=Experimental)
public abstract class RestApiBase
extends Resource
implements IRestApi

(experimental) Base implementation that are common to various implementations of IRestApi.

Nested Class Summary

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
protected	RestApiBase(software.constructs.Construct scope, String id)
protected	RestApiBase(software.constructs.Construct scope, String id, RestApiBaseProps props)
protected	RestApiBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RestApiBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IApiKey	addApiKey(String id) (experimental) Add an ApiKey.
IApiKey	addApiKey(String id, ApiKeyOptions options) (experimental) Add an ApiKey.
DomainName	addDomainName(String id, DomainNameOptions options) (experimental) Defines an API Gateway domain name and maps it to this API.
GatewayResponse	addGatewayResponse(String id, GatewayResponseOptions options) (experimental) Adds a new gateway response.
UsagePlan	addUsagePlan(String id) (experimental) Adds a usage plan.
UsagePlan	addUsagePlan(String id, UsagePlanProps props) (experimental) Adds a usage plan.
String	arnForExecuteApi() (experimental) Gets the "execute-api" ARN.
String	arnForExecuteApi(String method) (experimental) Gets the "execute-api" ARN.
String	arnForExecuteApi(String method, String path) (experimental) Gets the "execute-api" ARN.
String	arnForExecuteApi(String method, String path, String stage) (experimental) Gets the "execute-api" ARN.
Stage	getDeploymentStage() (experimental) API Gateway stage that points to the latest deployment (if defined).
DomainName	getDomainName() (experimental) The first domain name mapped to this API, if defined through the `domainName` configuration prop, or added via `addDomainName`.
Deployment	getLatestDeployment() (experimental) API Gateway deployment that represents the latest changes of the API.
abstract String	getRestApiId() (experimental) The ID of this API Gateway RestApi.
String	getRestApiName() (experimental) A human friendly name for this Rest API.
abstract String	getRestApiRootResourceId() (experimental) The resource ID of the root resource.
abstract IResource	getRoot() (experimental) Represents the root resource of this API endpoint ('/').
Metric	metric(String metricName) (experimental) Returns the given named metric for this API.
Metric	metric(String metricName, MetricOptions props) (experimental) Returns the given named metric for this API.
Metric	metricCacheHitCount() (experimental) Metric for the number of requests served from the API cache in a given period.
Metric	metricCacheHitCount(MetricOptions props) (experimental) Metric for the number of requests served from the API cache in a given period.
Metric	metricCacheMissCount() (experimental) Metric for the number of requests served from the backend in a given period, when API caching is enabled.
Metric	metricCacheMissCount(MetricOptions props) (experimental) Metric for the number of requests served from the backend in a given period, when API caching is enabled.
Metric	metricClientError() (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricClientError(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricCount() (experimental) Metric for the total number API requests in a given period.
Metric	metricCount(MetricOptions props) (experimental) Metric for the total number API requests in a given period.
Metric	metricIntegrationLatency() (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Metric	metricIntegrationLatency(MetricOptions props) (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Metric	metricLatency() (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	metricLatency(MetricOptions props) (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	metricServerError() (experimental) Metric for the number of server-side errors captured in a given period.
Metric	metricServerError(MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.
void	setDeploymentStage(Stage value) (experimental) API Gateway stage that points to the latest deployment (if defined).
String	urlForPath() (experimental) Returns the URL for an HTTP path.
String	urlForPath(String path) (experimental) Returns the URL for an HTTP path.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, 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

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

RestApiBase

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

RestApiBase

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

RestApiBase

@Stability(value=Experimental)
protected RestApiBase(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @Nullable
                                                     RestApiBaseProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

RestApiBase

@Stability(value=Experimental)
protected RestApiBase(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addApiKey

@Stability(value=Experimental)
 @NotNull
public IApiKey addApiKey(@NotNull
                                                                  String id,
                                                                  @Nullable
                                                                  ApiKeyOptions options)

(experimental) Add an ApiKey.

Parameters:

id - This parameter is required.

options -

addApiKey

@Stability(value=Experimental)
 @NotNull
public IApiKey addApiKey(@NotNull
                                                                  String id)

(experimental) Add an ApiKey.

Parameters:

id - This parameter is required.

addDomainName

@Stability(value=Experimental)
 @NotNull
public DomainName addDomainName(@NotNull
                                                                         String id,
                                                                         @NotNull
                                                                         DomainNameOptions options)

(experimental) Defines an API Gateway domain name and maps it to this API.

Parameters:

id - The construct id. This parameter is required.

options - custom domain options. This parameter is required.

addGatewayResponse

@Stability(value=Experimental)
 @NotNull
public GatewayResponse addGatewayResponse(@NotNull
                                                                                   String id,
                                                                                   @NotNull
                                                                                   GatewayResponseOptions options)

(experimental) Adds a new gateway response.

Parameters:

id - This parameter is required.

options - This parameter is required.

addUsagePlan

@Stability(value=Experimental)
 @NotNull
public UsagePlan addUsagePlan(@NotNull
                                                                       String id,
                                                                       @Nullable
                                                                       UsagePlanProps props)

(experimental) Adds a usage plan.

Parameters:

id - This parameter is required.

props -

addUsagePlan

@Stability(value=Experimental)
 @NotNull
public UsagePlan addUsagePlan(@NotNull
                                                                       String id)

(experimental) Adds a usage plan.

Parameters:

id - This parameter is required.

arnForExecuteApi

@Stability(value=Experimental)
 @NotNull
public String arnForExecuteApi(@Nullable
                                                                        String method,
                                                                        @Nullable
                                                                        String path,
                                                                        @Nullable
                                                                        String stage)

(experimental) Gets the "execute-api" ARN.

Specified by:

arnForExecuteApi in interface IRestApi

Parameters:

method -

path -

stage -

Returns:

The "execute-api" ARN.

arnForExecuteApi

@Stability(value=Experimental)
 @NotNull
public String arnForExecuteApi(@Nullable
                                                                        String method,
                                                                        @Nullable
                                                                        String path)

(experimental) Gets the "execute-api" ARN.

Specified by:

arnForExecuteApi in interface IRestApi

Parameters:

method -

path -

Returns:

The "execute-api" ARN.

arnForExecuteApi

@Stability(value=Experimental)
 @NotNull
public String arnForExecuteApi(@Nullable
                                                                        String method)

(experimental) Gets the "execute-api" ARN.

Specified by:

arnForExecuteApi in interface IRestApi

Parameters:

method -

Returns:

The "execute-api" ARN.

arnForExecuteApi

@Stability(value=Experimental)
 @NotNull
public String arnForExecuteApi()

(experimental) Gets the "execute-api" ARN.

Specified by:

arnForExecuteApi in interface IRestApi

Returns:

The "execute-api" ARN.

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              MetricOptions props)

(experimental) Returns the given named metric for this API.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

(experimental) Returns the given named metric for this API.

Parameters:

metricName - This parameter is required.

metricCacheHitCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCacheHitCount(@Nullable
                                                                           MetricOptions props)

(experimental) Metric for the number of requests served from the API cache in a given period.

Default: sum over 5 minutes

Parameters:

props -

metricCacheHitCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCacheHitCount()

(experimental) Metric for the number of requests served from the API cache in a given period.

Default: sum over 5 minutes

metricCacheMissCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCacheMissCount(@Nullable
                                                                            MetricOptions props)

(experimental) Metric for the number of requests served from the backend in a given period, when API caching is enabled.

Default: sum over 5 minutes

Parameters:

props -

metricCacheMissCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCacheMissCount()

(experimental) Metric for the number of requests served from the backend in a given period, when API caching is enabled.

Default: sum over 5 minutes

metricClientError

@Stability(value=Experimental)
 @NotNull
public Metric metricClientError(@Nullable
                                                                         MetricOptions props)

(experimental) Metric for the number of client-side errors captured in a given period.

Default: sum over 5 minutes

Parameters:

props -

metricClientError

@Stability(value=Experimental)
 @NotNull
public Metric metricClientError()

(experimental) Metric for the number of client-side errors captured in a given period.

Default: sum over 5 minutes

metricCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCount(@Nullable
                                                                   MetricOptions props)

(experimental) Metric for the total number API requests in a given period.

Default: sample count over 5 minutes

Parameters:

props -

metricCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCount()

(experimental) Metric for the total number API requests in a given period.

Default: sample count over 5 minutes

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricIntegrationLatency(@Nullable
                                                                                MetricOptions props)

(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Default: average over 5 minutes.

Parameters:

props -

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricIntegrationLatency()

(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Default: average over 5 minutes.

metricLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricLatency(@Nullable
                                                                     MetricOptions props)

(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Default: average over 5 minutes.

Parameters:

props -

metricLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricLatency()

(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Default: average over 5 minutes.

metricServerError

@Stability(value=Experimental)
 @NotNull
public Metric metricServerError(@Nullable
                                                                         MetricOptions props)

(experimental) Metric for the number of server-side errors captured in a given period.

Default: sum over 5 minutes

Parameters:

props -

metricServerError

@Stability(value=Experimental)
 @NotNull
public Metric metricServerError()

(experimental) Metric for the number of server-side errors captured in a given period.

Default: sum over 5 minutes

urlForPath

@Stability(value=Experimental)
 @NotNull
public String urlForPath(@Nullable
                                                                  String path)

(experimental) Returns the URL for an HTTP path.

Fails if deploymentStage is not set either by deploy or explicitly.

Parameters:

path -

urlForPath

@Stability(value=Experimental)
 @NotNull
public String urlForPath()

(experimental) Returns the URL for an HTTP path.

Fails if deploymentStage is not set either by deploy or explicitly.

getRestApiId

@Stability(value=Experimental)
 @NotNull
public abstract String getRestApiId()

(experimental) The ID of this API Gateway RestApi.

Specified by:

getRestApiId in interface IRestApi

getRestApiName

@Stability(value=Experimental)
 @NotNull
public String getRestApiName()

(experimental) A human friendly name for this Rest API.

Note that this is different from restApiId.

getRestApiRootResourceId

@Stability(value=Experimental)
 @NotNull
public abstract String getRestApiRootResourceId()

(experimental) The resource ID of the root resource.

Specified by:

getRestApiRootResourceId in interface IRestApi

getRoot

@Stability(value=Experimental)
 @NotNull
public abstract IResource getRoot()

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

Resources and Methods are added to this resource.

Specified by:

getRoot in interface IRestApi

getDomainName

@Stability(value=Experimental)
 @Nullable
public DomainName getDomainName()

(experimental) The first domain name mapped to this API, if defined through the `domainName` configuration prop, or added via `addDomainName`.

getLatestDeployment

@Stability(value=Experimental)
 @Nullable
public Deployment getLatestDeployment()

(experimental) API Gateway deployment that represents the latest changes of the API.

This resource will be automatically updated every time the REST API model changes. This will be undefined if deploy is false.

Specified by:

getLatestDeployment in interface IRestApi

getDeploymentStage

@Stability(value=Experimental)
 @NotNull
public Stage getDeploymentStage()

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

If deploy is disabled, you will need to explicitly assign this value in order to set up integrations.

Specified by:

getDeploymentStage in interface IRestApi

setDeploymentStage

@Stability(value=Experimental)
public void setDeploymentStage(@NotNull
                                                              Stage value)

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

If deploy is disabled, you will need to explicitly assign this value in order to set up integrations.

Specified by:

setDeploymentStage in interface IRestApi