software.amazon.awscdk.services.stepfunctions

Class StateTransitionMetric

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.StateTransitionMetric

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.507Z")
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 Summary

Constructors

Modifier	Constructor and Description
	StateTransitionMetric()
protected	StateTransitionMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StateTransitionMetric(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static Metric	metric(java.lang.String metricName) Return the given named metric for the service's state transition metrics.
static Metric	metric(java.lang.String metricName, MetricOptions props) Return the given named metric for the service's state transition metrics.
static Metric	metricConsumedCapacity() Metric for the number of available state transitions per second.
static Metric	metricConsumedCapacity(MetricOptions props) Metric for the number of available state transitions per second.
static Metric	metricProvisionedBucketSize() Metric for the number of available state transitions.
static Metric	metricProvisionedBucketSize(MetricOptions props) Metric for the number of available state transitions.
static Metric	metricProvisionedRefillRate() Metric for the provisioned steady-state execution rate.
static Metric	metricProvisionedRefillRate(MetricOptions props) Metric for the provisioned steady-state execution rate.
static Metric	metricThrottledEvents() Metric for the number of throttled state transitions.
static Metric	metricThrottledEvents(MetricOptions props) Metric for the number of throttled state transitions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StateTransitionMetric

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

StateTransitionMetric

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

StateTransitionMetric

public StateTransitionMetric()

Method Detail

metric

public static Metric metric(java.lang.String metricName,
                            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

public static Metric metric(java.lang.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

public static Metric metricConsumedCapacity(MetricOptions props)

Metric for the number of available state transitions per second.

Default: average over 5 minutes

Parameters:

props -

metricConsumedCapacity

public static Metric metricConsumedCapacity()

Metric for the number of available state transitions per second.

Default: average over 5 minutes

metricProvisionedBucketSize

public static Metric metricProvisionedBucketSize(MetricOptions props)

Metric for the number of available state transitions.

Default: average over 5 minutes

Parameters:

props -

metricProvisionedBucketSize

public static Metric metricProvisionedBucketSize()

Metric for the number of available state transitions.

Default: average over 5 minutes

metricProvisionedRefillRate

public static Metric metricProvisionedRefillRate(MetricOptions props)

Metric for the provisioned steady-state execution rate.

Default: average over 5 minutes

Parameters:

props -

metricProvisionedRefillRate

public static Metric metricProvisionedRefillRate()

Metric for the provisioned steady-state execution rate.

Default: average over 5 minutes

metricThrottledEvents

public static Metric metricThrottledEvents(MetricOptions props)

Metric for the number of throttled state transitions.

Default: sum over 5 minutes

Parameters:

props -

metricThrottledEvents

public static Metric metricThrottledEvents()

Metric for the number of throttled state transitions.

Default: sum over 5 minutes