software.amazon.awscdk.services.apigatewayv2

Class HttpApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.HttpApi

All Implemented Interfaces:

IDependable, IResource, IApi, IHttpApi, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:21.417Z")
 @Stability(value=Experimental)
public class HttpApi
extends Resource
implements IHttpApi, IApi

(experimental) Create a new API Gateway HTTP API endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpApi.Builder (experimental) A fluent builder for HttpApi.

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.apigatewayv2.IHttpApi

IHttpApi.Jsii$Default, IHttpApi.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<HttpRoute>	addRoutes(AddRoutesOptions options) (experimental) Add multiple routes that uses the same configuration.
HttpStage	addStage(String id, HttpStageOptions options) (experimental) Add a new stage.
VpcLink	addVpcLink(VpcLinkProps options) (experimental) Add a new VpcLink.
static IHttpApi	fromHttpApiAttributes(software.constructs.Construct scope, String id, HttpApiAttributes attrs) (experimental) Import an existing HTTP API into this CDK app.
String	getApiEndpoint() (experimental) Get the default endpoint for this API.
String	getApiId() (experimental) The identifier of this API Gateway API.
IStage	getDefaultStage() (experimental) The default stage of this API.
Boolean	getDisableExecuteApiEndpoint() (experimental) Specifies whether clients can invoke this HTTP API by using the default execute-api endpoint.
String	getHttpApiId() (experimental) The identifier of this API Gateway HTTP API.
String	getHttpApiName() (experimental) A human friendly name for this HTTP API.
String	getUrl() (experimental) Get the URL to the default stage of this API.
Metric	metric(String metricName) (experimental) Return the given named metric for this Api Gateway.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this Api Gateway.
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	metricDataProcessed() (experimental) Metric for the amount of data processed in bytes.
Metric	metricDataProcessed(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.
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.

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.core.IResource

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

HttpApi

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

HttpApi

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

HttpApi

@Stability(value=Experimental)
public HttpApi(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @Nullable
                                              HttpApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

HttpApi

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromHttpApiAttributes

@Stability(value=Experimental)
 @NotNull
public static IHttpApi fromHttpApiAttributes(@NotNull
                                                                                      software.constructs.Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      HttpApiAttributes attrs)

(experimental) Import an existing HTTP API into this CDK app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addRoutes

@Stability(value=Experimental)
 @NotNull
public List<HttpRoute> addRoutes(@NotNull
                                                                          AddRoutesOptions options)

(experimental) Add multiple routes that uses the same configuration.

The routes all go to the same path, but for different methods.

Parameters:

options - This parameter is required.

addStage

@Stability(value=Experimental)
 @NotNull
public HttpStage addStage(@NotNull
                                                                   String id,
                                                                   @NotNull
                                                                   HttpStageOptions options)

(experimental) Add a new stage.

Parameters:

id - This parameter is required.

options - This parameter is required.

addVpcLink

@Stability(value=Experimental)
 @NotNull
public VpcLink addVpcLink(@NotNull
                                                                   VpcLinkProps options)

(experimental) Add a new VpcLink.

Specified by:

addVpcLink in interface IHttpApi

Parameters:

options - This parameter is required.

metric

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

(experimental) Return the given named metric for this Api Gateway.

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

props -

metric

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

(experimental) Return the given named metric for this Api Gateway.

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

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.

Specified by:

metricClientError in interface IApi

Parameters:

props -

metricClientError

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

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

Specified by:

metricClientError in interface IApi

metricCount

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

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

Specified by:

metricCount in interface IApi

Parameters:

props -

metricCount

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

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

Specified by:

metricCount in interface IApi

metricDataProcessed

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

(experimental) Metric for the amount of data processed in bytes.

Specified by:

metricDataProcessed in interface IApi

Parameters:

props -

metricDataProcessed

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

(experimental) Metric for the amount of data processed in bytes.

Specified by:

metricDataProcessed in interface IApi

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.

Specified by:

metricIntegrationLatency in interface IApi

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.

Specified by:

metricIntegrationLatency in interface IApi

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.

Specified by:

metricLatency in interface IApi

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.

Specified by:

metricLatency in interface IApi

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.

Specified by:

metricServerError in interface IApi

Parameters:

props -

metricServerError

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

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

Specified by:

metricServerError in interface IApi

getApiEndpoint

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

(experimental) Get the default endpoint for this API.

Specified by:

getApiEndpoint in interface IApi

getApiId

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

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

getHttpApiId

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

(experimental) The identifier of this API Gateway HTTP API.

Specified by:

getHttpApiId in interface IHttpApi

getDefaultStage

@Stability(value=Experimental)
 @Nullable
public IStage getDefaultStage()

(experimental) The default stage of this API.

getDisableExecuteApiEndpoint

@Stability(value=Experimental)
 @Nullable
public Boolean getDisableExecuteApiEndpoint()

(experimental) Specifies whether clients can invoke this HTTP API by using the default execute-api endpoint.

getHttpApiName

@Stability(value=Experimental)
 @Nullable
public String getHttpApiName()

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

Note that this is different from httpApiId.

getUrl

@Stability(value=Experimental)
 @Nullable
public String getUrl()

(experimental) Get the URL to the default stage of this API.

Returns undefined if createDefaultStage is unset.