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.103.1 (build bef2dea)",
           date="2024-10-25T14:21:24.360Z")
@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();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Metric	metric(String metricName)	Return the given named metric for the service's state transition metrics.
static Metric	metric(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 software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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