Package software.amazon.awscdk.services.stepfunctions

Class StateTransitionMetric

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.stepfunctions.StateTransitionMetric
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:10.191Z") @Stability(Stable) public class StateTransitionMetric extends software.amazon.jsii.JsiiObject
Metrics on the rate limiting performed on state machine execution.

These rate limits are shared across all state machines.

Example: 

 Alarm.Builder.create(this, "ThrottledAlarm")
         .metric(StateTransitionMetric.metricThrottledEvents())
         .threshold(10)
         .evaluationPeriods(2)
         .build();

  • Constructor Details

    • StateTransitionMetric

      protected StateTransitionMetric(software.amazon.jsii.JsiiObjectRef objRef)

    • StateTransitionMetric

      protected StateTransitionMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • StateTransitionMetric

      @Stability(Stable) public StateTransitionMetric()

  • Method Details

    • metric

      @Stability(Stable) @NotNull public static Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for the service's state transition metrics.

      Default: average over 5 minutes

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Stable) @NotNull public static Metric metric(@NotNull String metricName)
      Return the given named metric for the service's state transition metrics.

      Default: average over 5 minutes

      Parameters:
      metricName - This parameter is required.

    • metricConsumedCapacity

      @Stability(Stable) @NotNull public static Metric metricConsumedCapacity(@Nullable MetricOptions props)
      Metric for the number of available state transitions per second.

      Default: average over 5 minutes

      Parameters:
      props -

    • metricConsumedCapacity

      @Stability(Stable) @NotNull public static Metric metricConsumedCapacity()
      Metric for the number of available state transitions per second.

      Default: average over 5 minutes

    • metricProvisionedBucketSize

      @Stability(Stable) @NotNull public static Metric metricProvisionedBucketSize(@Nullable MetricOptions props)
      Metric for the number of available state transitions.

      Default: average over 5 minutes

      Parameters:
      props -

    • metricProvisionedBucketSize

      @Stability(Stable) @NotNull public static Metric metricProvisionedBucketSize()
      Metric for the number of available state transitions.

      Default: average over 5 minutes

    • metricProvisionedRefillRate

      @Stability(Stable) @NotNull public static Metric metricProvisionedRefillRate(@Nullable MetricOptions props)
      Metric for the provisioned steady-state execution rate.

      Default: average over 5 minutes

      Parameters:
      props -

    • metricProvisionedRefillRate

      @Stability(Stable) @NotNull public static Metric metricProvisionedRefillRate()
      Metric for the provisioned steady-state execution rate.

      Default: average over 5 minutes

    • metricThrottledEvents

      @Stability(Stable) @NotNull public static Metric metricThrottledEvents(@Nullable MetricOptions props)
      Metric for the number of throttled state transitions.

      Default: sum over 5 minutes

      Parameters:
      props -

    • metricThrottledEvents

      @Stability(Stable) @NotNull public static Metric metricThrottledEvents()
      Metric for the number of throttled state transitions.

      Default: sum over 5 minutes