software.amazon.awscdk.services.apigatewayv2

Interface IHttpApi.Jsii$Default

All Superinterfaces:

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

All Known Implementing Classes:

IHttpApi.Jsii$Proxy

Enclosing interface:

IHttpApi

@Internal
public static interface IHttpApi.Jsii$Default
extends IHttpApi, IApi.Jsii$Default

Internal default implementation for IHttpApi.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IHttpApi

IHttpApi.Jsii$Default, IHttpApi.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default VpcLink	addVpcLink(VpcLinkProps options) (experimental) Add a new VpcLink.
default void	applyRemovalPolicy(RemovalPolicy policy) (experimental) Apply the given removal policy to this resource.
default String	getApiEndpoint() (experimental) The default endpoint for an API.
default String	getApiId() (experimental) The identifier of this API Gateway API.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default String	getHttpApiId() Deprecated. - use apiId instead
default ConstructNode	getNode() (experimental) The construct tree node for this construct.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this Api Gateway.
default Metric	metricClientError(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.
default Metric	metricCount(MetricOptions props) (experimental) Metric for the total number API requests in a given period.
default Metric	metricDataProcessed(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.
default 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.
default 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.
default Metric	metricServerError(MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.IHttpApi

metricClientError, metricCount, metricDataProcessed, metricIntegrationLatency, metricLatency, metricServerError

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.IApi

metric

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Experimental)
 @NotNull
default ConstructNode getNode()

(experimental) The construct tree node for this construct.

Specified by:

getNode in interface IApi.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IApi.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IApi.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getApiEndpoint

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

(experimental) The default endpoint for an API.

Specified by:

getApiEndpoint in interface IApi

Specified by:

getApiEndpoint in interface IApi.Jsii$Default

getApiId

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

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

Specified by:

getApiId in interface IApi.Jsii$Default

getHttpApiId

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
default String getHttpApiId()

Deprecated. - use apiId instead

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

Specified by:

getHttpApiId in interface IHttpApi

applyRemovalPolicy

@Stability(value=Experimental)
default void applyRemovalPolicy(@NotNull
                                                               RemovalPolicy policy)

(experimental) Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IApi.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

metric

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

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

Default: - average over 5 minutes

Specified by:

metric in interface IApi

Specified by:

metric in interface IApi.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

addVpcLink

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

(experimental) Add a new VpcLink.

Specified by:

addVpcLink in interface IHttpApi

Parameters:

options - This parameter is required.

metricClientError

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

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

Default: - sum over 5 minutes

Specified by:

metricClientError in interface IHttpApi

Parameters:

props -

metricCount

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

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

Default: - SampleCount over 5 minutes

Specified by:

metricCount in interface IHttpApi

Parameters:

props -

metricDataProcessed

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

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

Default: - sum over 5 minutes

Specified by:

metricDataProcessed in interface IHttpApi

Parameters:

props -

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
default 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: - no statistic

Specified by:

metricIntegrationLatency in interface IHttpApi

Parameters:

props -

metricLatency

@Stability(value=Experimental)
 @NotNull
default 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: - no statistic

Specified by:

metricLatency in interface IHttpApi

Parameters:

props -

metricServerError

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

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

Default: - sum over 5 minutes

Specified by:

metricServerError in interface IHttpApi

Parameters:

props -