class StateTransitionMetric

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.StateTransitionMetric
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#StateTransitionMetric
Java	software.amazon.awscdk.services.stepfunctions.StateTransitionMetric
Python	aws_cdk.aws_stepfunctions.StateTransitionMetric
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » StateTransitionMetric

Metrics on the rate limiting performed on state machine execution.

These rate limits are shared across all state machines.

Example

new cloudwatch.Alarm(this, 'ThrottledAlarm', {
  metric: sfn.StateTransitionMetric.metricThrottledEvents(),
  threshold: 10,
  evaluationPeriods: 2,
});

Initializer

new StateTransitionMetric()

Methods

Name	Description
static metric(metricName, props?)	Return the given named metric for the service's state transition metrics.
static metricConsumedCapacity(props?)	Metric for the number of available state transitions per second.
static metricProvisionedBucketSize(props?)	Metric for the number of available state transitions.
static metricProvisionedRefillRate(props?)	Metric for the provisioned steady-state execution rate.
static metricThrottledEvents(props?)	Metric for the number of throttled state transitions.

---

static metric(metricName, props?)

public static metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for the service's state transition metrics.

---

static metricConsumedCapacity(props?)

public static metricConsumedCapacity(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of available state transitions per second.

---

static metricProvisionedBucketSize(props?)

public static metricProvisionedBucketSize(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of available state transitions.

---

static metricProvisionedRefillRate(props?)

public static metricProvisionedRefillRate(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the provisioned steady-state execution rate.

---

static metricThrottledEvents(props?)

public static metricThrottledEvents(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of throttled state transitions.