Package software.amazon.awscdk.services.apigatewayv2

Class IHttpApi.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.IHttpApi.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IHttpApi

@Internal
public static final class IHttpApi.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IHttpApi.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

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

IApi.Jsii$Default, IApi.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

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

IHttpApi.Jsii$Default, IHttpApi.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IApi.Jsii$Default

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IHttpApi.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

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 IHttpApi.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IApi.Jsii$Default

Specified by:

getStack in interface IHttpApi.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getApiEndpoint

@Stability(Experimental)
@NotNull
public final String getApiEndpoint()

(experimental) The default endpoint for an API.

Specified by:

getApiEndpoint in interface IApi

Specified by:

getApiEndpoint in interface IApi.Jsii$Default

Specified by:

getApiEndpoint in interface IHttpApi.Jsii$Default

getApiId

@Stability(Experimental)
@NotNull
public final String getApiId()

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

Specified by:

getApiId in interface IApi.Jsii$Default

Specified by:

getApiId in interface IHttpApi.Jsii$Default

getHttpApiId

@Stability(Deprecated)
@Deprecated
@NotNull
public final String getHttpApiId()

Deprecated.

• use apiId instead

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

Specified by:

getHttpApiId in interface IHttpApi

Specified by:

getHttpApiId in interface IHttpApi.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

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 IHttpApi.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

metric

@Stability(Experimental)
@NotNull
public final 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

Specified by:

metric in interface IHttpApi.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Experimental)
@NotNull
public final Metric metric(@NotNull
 String metricName)

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

Default: - average over 5 minutes

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

addVpcLink

@Stability(Experimental)
@NotNull
public final VpcLink addVpcLink(@NotNull
 VpcLinkProps options)

(experimental) Add a new VpcLink.

Specified by:

addVpcLink in interface IHttpApi

Specified by:

addVpcLink in interface IHttpApi.Jsii$Default

Parameters:

options - This parameter is required.

metricClientError

@Stability(Experimental)
@NotNull
public final 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

Specified by:

metricClientError in interface IHttpApi.Jsii$Default

Parameters:

props -

metricClientError

@Stability(Experimental)
@NotNull
public final Metric metricClientError()

(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

metricCount

@Stability(Experimental)
@NotNull
public final 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

Specified by:

metricCount in interface IHttpApi.Jsii$Default

Parameters:

props -

metricCount

@Stability(Experimental)
@NotNull
public final Metric metricCount()

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

Default: - SampleCount over 5 minutes

Specified by:

metricCount in interface IHttpApi

metricDataProcessed

@Stability(Experimental)
@NotNull
public final 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

Specified by:

metricDataProcessed in interface IHttpApi.Jsii$Default

Parameters:

props -

metricDataProcessed

@Stability(Experimental)
@NotNull
public final Metric metricDataProcessed()

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

Default: - sum over 5 minutes

Specified by:

metricDataProcessed in interface IHttpApi

metricIntegrationLatency

@Stability(Experimental)
@NotNull
public final 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

Specified by:

metricIntegrationLatency in interface IHttpApi.Jsii$Default

Parameters:

props -

metricIntegrationLatency

@Stability(Experimental)
@NotNull
public final 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: - no statistic

Specified by:

metricIntegrationLatency in interface IHttpApi

metricLatency

@Stability(Experimental)
@NotNull
public final 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

Specified by:

metricLatency in interface IHttpApi.Jsii$Default

Parameters:

props -

metricLatency

@Stability(Experimental)
@NotNull
public final 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: - no statistic

Specified by:

metricLatency in interface IHttpApi

metricServerError

@Stability(Experimental)
@NotNull
public final 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

Specified by:

metricServerError in interface IHttpApi.Jsii$Default

Parameters:

props -

metricServerError

@Stability(Experimental)
@NotNull
public final Metric metricServerError()

(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