Package software.amazon.awscdk.services.apigatewayv2

Interface IHttpApi.Jsii$Default

All Superinterfaces:
IApi, IApi.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.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.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface IApi.Jsii$Default
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default 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 IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      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(Stable) @NotNull default String getApiEndpoint()
      The default endpoint for an API.
      Specified by:
      getApiEndpoint in interface IApi
      Specified by:
      getApiEndpoint in interface IApi.Jsii$Default

    • getApiId

      @Stability(Stable) @NotNull default String getApiId()
      The identifier of this API Gateway API.
      Specified by:
      getApiId in interface IApi
      Specified by:
      getApiId in interface IApi.Jsii$Default

    • 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

    • applyRemovalPolicy

      @Stability(Stable) default 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 IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • metric

      @Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      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(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 -

    • 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 -

    • 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 -

    • 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 -

    • 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 -

    • 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 -

    • 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 -