Package software.amazon.awscdk.services.apigatewayv2

Interface IHttpApi.Jsii$Default

All Superinterfaces:
IApi, IApi.Jsii$Default, IApiRef, IApiRef.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IHttpApi, IHttpApiRef, IHttpApiRef.Jsii$Default, 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, IHttpApiRef.Jsii$Default
Internal default implementation for IHttpApi.

  • 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

      Specified by:
      getDefaultAuthorizationScopes in interface IHttpApi

    • getDefaultAuthorizer

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

      Default: - no default authorizer

      Specified by:
      getDefaultAuthorizer in interface IHttpApi

    • getDefaultStage

      @Stability(Stable) @Nullable default IHttpStage getDefaultStage()
      The default stage of this API.

      Default: - a stage will be created

      Specified by:
      getDefaultStage in interface IHttpApi

    • metric

      @Stability(Stable) @NotNull default 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
      Parameters:
      metricName - This parameter is required.

    • addVpcLink

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

      Specified by:
      addVpcLink in interface IHttpApi
      Parameters:
      options - This parameter is required.

    • arnForExecuteApi

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

      Specified by:
      arnForExecuteApi in interface IHttpApi
      Parameters:
      method -
      path -
      stage -

    • arnForExecuteApi

      @Stability(Stable) @NotNull default 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
      Parameters:
      method -
      path -

    • arnForExecuteApi

      @Stability(Stable) @NotNull default 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
      Parameters:
      method -

    • arnForExecuteApi

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

    • metricClientError

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

    • metricClientError

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

    • metricCount

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

      Default: - SampleCount over 5 minutes

      Specified by:
      metricCount in interface IHttpApi
      Parameters:
      props -

    • metricCount

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

      Default: - SampleCount over 5 minutes

      Specified by:
      metricCount in interface IHttpApi

    • metricDataProcessed

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

      Default: - sum over 5 minutes

      Specified by:
      metricDataProcessed in interface IHttpApi
      Parameters:
      props -

    • metricDataProcessed

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

      Default: - sum over 5 minutes

      Specified by:
      metricDataProcessed in interface IHttpApi

    • metricIntegrationLatency

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

      Specified by:
      metricIntegrationLatency in interface IHttpApi
      Parameters:
      props -

    • metricIntegrationLatency

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

    • metricLatency

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

      Specified by:
      metricLatency in interface IHttpApi
      Parameters:
      props -

    • metricLatency

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

    • metricServerError

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

    • metricServerError

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