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:
IApiRef, IApiRef.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IApi, IApi.Jsii$Default, IHttpApi, IHttpApi.Jsii$Default, IHttpApiRef, IHttpApiRef.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.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.

  • Constructor Details

    • Jsii$Proxy

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

  • Method Details

    • metric

      @Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName)
      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.

    • arnForExecuteApi

      @Stability(Stable) @NotNull public final String arnForExecuteApi(@Nullable String method, @Nullable String path)
      Get the "execute-api" ARN.

      When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.

      Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '*', representing all methods. If 'path' is not specified, it defaults to '/*', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.

      Specified by:
      arnForExecuteApi in interface IHttpApi
      Specified by:
      arnForExecuteApi in interface IHttpApi.Jsii$Default
      Parameters:
      method -
      path -

    • arnForExecuteApi

      @Stability(Stable) @NotNull public final String arnForExecuteApi(@Nullable String method)
      Get the "execute-api" ARN.

      When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.

      Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '*', representing all methods. If 'path' is not specified, it defaults to '/*', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.

      Specified by:
      arnForExecuteApi in interface IHttpApi
      Specified by:
      arnForExecuteApi in interface IHttpApi.Jsii$Default
      Parameters:
      method -

    • arnForExecuteApi

      @Stability(Stable) @NotNull public final String arnForExecuteApi()
      Get the "execute-api" ARN.

      When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.

      Default: - The default behavior applies when no specific method, path, or stage is provided. In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if 'method' is not specified, it defaults to '*', representing all methods. If 'path' is not specified, it defaults to '/*', representing all paths. If 'stage' is not specified, it also defaults to '*', representing all stages.

      Specified by:
      arnForExecuteApi in interface IHttpApi
      Specified by:
      arnForExecuteApi in interface IHttpApi.Jsii$Default

    • metricClientError

      @Stability(Stable) @NotNull public final Metric metricClientError()
      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

    • metricCount

      @Stability(Stable) @NotNull public final Metric metricCount()
      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

    • metricDataProcessed

      @Stability(Stable) @NotNull public final Metric metricDataProcessed()
      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

    • metricIntegrationLatency

      @Stability(Stable) @NotNull public final Metric metricIntegrationLatency()
      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

    • metricLatency

      @Stability(Stable) @NotNull public final Metric metricLatency()
      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

    • metricServerError

      @Stability(Stable) @NotNull public final Metric metricServerError()
      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