Package software.amazon.awscdk.services.apigatewayv2

Interface IHttpStage.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IHttpStage, IResource, IResource.Jsii$Default, IStage, IStage.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IHttpStage.Jsii$Proxy
Enclosing interface:
IHttpStage
@Internal public static interface IHttpStage.Jsii$Default extends IHttpStage, IStage.Jsii$Default
Internal default implementation for IHttpStage.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      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
      Specified by:
      getNode in interface IStage.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware
      Specified by:
      getEnv in interface IEnvironmentAware.Jsii$Default
      Specified by:
      getEnv in interface IResource.Jsii$Default
      Specified by:
      getEnv in interface IStage.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default
      Specified by:
      getStack in interface IStage.Jsii$Default

    • getStageName

      @Stability(Stable) @NotNull default String getStageName()
      The name of the stage;

      its primary identifier.

      Specified by:
      getStageName in interface IStage
      Specified by:
      getStageName in interface IStage.Jsii$Default

    • getUrl

      @Stability(Stable) @NotNull default String getUrl()
      The URL to this stage.
      Specified by:
      getUrl in interface IStage
      Specified by:
      getUrl in interface IStage.Jsii$Default

    • getApi

      @Stability(Stable) @NotNull default IHttpApi getApi()
      The API this stage is associated to.
      Specified by:
      getApi in interface IHttpStage

    • getDomainUrl

      @Stability(Stable) @NotNull default String getDomainUrl()
      The custom domain URL to this stage.
      Specified by:
      getDomainUrl in interface IHttpStage

    • 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 IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IStage.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addStageVariable

      @Stability(Stable) default void addStageVariable(@NotNull String name, @NotNull String value)
      Adds a stage variable to this stage.

      Specified by:
      addStageVariable in interface IStage
      Specified by:
      addStageVariable in interface IStage.Jsii$Default
      Parameters:
      name - The name of the stage variable. This parameter is required.
      value - The value of the stage variable. This parameter is required.

    • metric

      @Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this HTTP Api Gateway Stage.

      Default: - average over 5 minutes

      Specified by:
      metric in interface IStage
      Specified by:
      metric in interface IStage.Jsii$Default
      Parameters:
      metricName - This parameter is required.
      props -

    • 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 IHttpStage
      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 IHttpStage
      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 IHttpStage
      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 IHttpStage
      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 IHttpStage
      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 IHttpStage
      Parameters:
      props -