Interface IHttpApi

All Superinterfaces:
IApi, software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IHttpApi.Jsii$Default
All Known Implementing Classes:
HttpApi, IHttpApi.Jsii$Proxy

@Generated(value="jsii-pacmak/1.95.0 (build f1ff514)", date="2024-03-26T18:09:19.064Z") @Stability(Stable) public interface IHttpApi extends software.amazon.jsii.JsiiSerializable, IApi
Represents an HTTP API.
  • Method Details

    • getDefaultAuthorizationScopes

      @Stability(Stable) @Nullable default List<String> getDefaultAuthorizationScopes()
      Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.

      The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

      Default: - no default authorization scopes

    • getDefaultAuthorizer

      @Stability(Stable) @Nullable default IHttpRouteAuthorizer getDefaultAuthorizer()
      Default Authorizer applied to all routes in the gateway.

      Default: - no default authorizer

    • addVpcLink

      @Stability(Stable) @NotNull VpcLink addVpcLink(@NotNull VpcLinkProps options)
      Add a new VpcLink.

      Parameters:
      options - This parameter is required.
    • arnForExecuteApi

      @Stability(Stable) @NotNull String arnForExecuteApi(@Nullable String method, @Nullable String path, @Nullable String stage)
      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.

      Parameters:
      method -
      path -
      stage -
    • arnForExecuteApi

      @Stability(Stable) @NotNull 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.

      Parameters:
      method -
      path -
    • arnForExecuteApi

      @Stability(Stable) @NotNull 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.

      Parameters:
      method -
    • arnForExecuteApi

      @Stability(Stable) @NotNull 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.

    • metricClientError

      @Stability(Stable) @NotNull Metric metricClientError(@Nullable MetricOptions props)
      Metric for the number of client-side errors captured in a given period.

      Default: - sum over 5 minutes

      Parameters:
      props -
    • metricClientError

      @Stability(Stable) @NotNull Metric metricClientError()
      Metric for the number of client-side errors captured in a given period.

      Default: - sum over 5 minutes

    • metricCount

      @Stability(Stable) @NotNull Metric metricCount(@Nullable MetricOptions props)
      Metric for the total number API requests in a given period.

      Default: - SampleCount over 5 minutes

      Parameters:
      props -
    • metricCount

      @Stability(Stable) @NotNull Metric metricCount()
      Metric for the total number API requests in a given period.

      Default: - SampleCount over 5 minutes

    • metricDataProcessed

      @Stability(Stable) @NotNull Metric metricDataProcessed(@Nullable MetricOptions props)
      Metric for the amount of data processed in bytes.

      Default: - sum over 5 minutes

      Parameters:
      props -
    • metricDataProcessed

      @Stability(Stable) @NotNull Metric metricDataProcessed()
      Metric for the amount of data processed in bytes.

      Default: - sum over 5 minutes

    • metricIntegrationLatency

      @Stability(Stable) @NotNull Metric metricIntegrationLatency(@Nullable MetricOptions props)
      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

      Parameters:
      props -
    • metricIntegrationLatency

      @Stability(Stable) @NotNull 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

    • metricLatency

      @Stability(Stable) @NotNull Metric metricLatency(@Nullable MetricOptions props)
      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

      Parameters:
      props -
    • metricLatency

      @Stability(Stable) @NotNull 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

    • metricServerError

      @Stability(Stable) @NotNull Metric metricServerError(@Nullable MetricOptions props)
      Metric for the number of server-side errors captured in a given period.

      Default: - sum over 5 minutes

      Parameters:
      props -
    • metricServerError

      @Stability(Stable) @NotNull Metric metricServerError()
      Metric for the number of server-side errors captured in a given period.

      Default: - sum over 5 minutes