software.amazon.awscdk.services.apigatewayv2

Class HttpApi

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.HttpApi

All Implemented Interfaces:

IConstruct, IDependable, IResource, IApi, IHttpApi

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:17.734Z")
public class HttpApi
extends Resource
implements IHttpApi, IApi

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

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpLambdaIntegration;
 Function booksDefaultFn;
 HttpLambdaIntegration booksIntegration = new HttpLambdaIntegration("BooksIntegration", booksDefaultFn);
 HttpApi httpApi = new HttpApi(this, "HttpApi");
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/books")
         .methods(List.of(HttpMethod.GET))
         .integration(booksIntegration)
         .build());
 

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 interface software.amazon.awscdk.services.apigatewayv2.IHttpApi

IHttpApi.Jsii$Default, IHttpApi.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.List<HttpRoute>	addRoutes(AddRoutesOptions options) (experimental) Add multiple routes that uses the same configuration.
HttpStage	addStage(java.lang.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, java.lang.String id, HttpApiAttributes attrs) (experimental) Import an existing HTTP API into this CDK app.
java.lang.String	getApiEndpoint() (experimental) Get the default endpoint for this API.
java.lang.String	getApiId() (experimental) The identifier of this API Gateway API.
IHttpStage	getDefaultStage() (experimental) The default stage of this API.
java.lang.Boolean	getDisableExecuteApiEndpoint() (experimental) Specifies whether clients can invoke this HTTP API by using the default execute-api endpoint.
java.lang.String	getHttpApiId() (experimental) The identifier of this API Gateway HTTP API.
java.lang.String	getHttpApiName() (experimental) A human friendly name for this HTTP API.
java.lang.String	getUrl() (experimental) Get the URL to the default stage of this API.
Metric	metric(java.lang.String metricName) (experimental) Return the given named metric for this Api Gateway.
Metric	metric(java.lang.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 java.lang.Object

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

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Constructor Detail

HttpApi

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

HttpApi

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

HttpApi

public HttpApi(software.constructs.Construct scope,
               java.lang.String id,
               HttpApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

HttpApi

public HttpApi(software.constructs.Construct scope,
               java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromHttpApiAttributes

public static IHttpApi fromHttpApiAttributes(software.constructs.Construct scope,
                                             java.lang.String id,
                                             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

public java.util.List<HttpRoute> addRoutes(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

public HttpStage addStage(java.lang.String id,
                          HttpStageOptions options)

(experimental) Add a new stage.

Parameters:

id - This parameter is required.

options - This parameter is required.

addVpcLink

public VpcLink addVpcLink(VpcLinkProps options)

(experimental) Add a new VpcLink.

Specified by:

addVpcLink in interface IHttpApi

Parameters:

options - This parameter is required.

metric

public Metric metric(java.lang.String metricName,
                     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

public Metric metric(java.lang.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

public Metric metricClientError(MetricOptions props)

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

Specified by:

metricClientError in interface IHttpApi

Parameters:

props -

metricClientError

public Metric metricClientError()

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

Specified by:

metricClientError in interface IHttpApi

metricCount

public Metric metricCount(MetricOptions props)

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

Specified by:

metricCount in interface IHttpApi

Parameters:

props -

metricCount

public Metric metricCount()

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

Specified by:

metricCount in interface IHttpApi

metricDataProcessed

public Metric metricDataProcessed(MetricOptions props)

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

Specified by:

metricDataProcessed in interface IHttpApi

Parameters:

props -

metricDataProcessed

public Metric metricDataProcessed()

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

Specified by:

metricDataProcessed in interface IHttpApi

metricIntegrationLatency

public 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.

Specified by:

metricIntegrationLatency in interface IHttpApi

Parameters:

props -

metricIntegrationLatency

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 IHttpApi

metricLatency

public 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.

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

Specified by:

metricLatency in interface IHttpApi

Parameters:

props -

metricLatency

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 IHttpApi

metricServerError

public Metric metricServerError(MetricOptions props)

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

Specified by:

metricServerError in interface IHttpApi

Parameters:

props -

metricServerError

public Metric metricServerError()

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

Specified by:

metricServerError in interface IHttpApi

getApiEndpoint

public java.lang.String getApiEndpoint()

(experimental) Get the default endpoint for this API.

Specified by:

getApiEndpoint in interface IApi

getApiId

public java.lang.String getApiId()

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

getHttpApiId

public java.lang.String getHttpApiId()

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

Specified by:

getHttpApiId in interface IHttpApi

getDefaultStage

public IHttpStage getDefaultStage()

(experimental) The default stage of this API.

getDisableExecuteApiEndpoint

public java.lang.Boolean getDisableExecuteApiEndpoint()

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

getHttpApiName

public java.lang.String getHttpApiName()

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

Note that this is different from httpApiId.

getUrl

public java.lang.String getUrl()

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

Returns undefined if createDefaultStage is unset.