AWS CDK Reference

Appearance

v2.274.0

StateTransitionMetric Class ​

Metrics on the rate limiting performed on state machine execution.

These rate limits are shared across all state machines.

Source
aws-stepfunctions/lib/state-transition-metrics.ts

Example ​

ts
new cloudwatch.Alarm(this, 'ThrottledAlarm', {
  metric: sfn.StateTransitionMetric.metricThrottledEvents(),
  threshold: 10,
  evaluationPeriods: 2,
});
python
cloudwatch.Alarm(self, "ThrottledAlarm",
    metric=sfn.StateTransitionMetric.metric_throttled_events(),
    threshold=10,
    evaluation_periods=2
)
java
Alarm.Builder.create(this, "ThrottledAlarm")
        .metric(StateTransitionMetric.metricThrottledEvents())
        .threshold(10)
        .evaluationPeriods(2)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new Alarm(this, "ThrottledAlarm", new AlarmProps {
    Metric = StateTransitionMetric.MetricThrottledEvents(),
    Threshold = 10,
    EvaluationPeriods = 2
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
cloudwatch.NewAlarm(this, jsii.String("ThrottledAlarm"), &AlarmProps{
	Metric: sfn.StateTransitionMetric_MetricThrottledEvents(),
	Threshold: jsii.Number(10),
	EvaluationPeriods: jsii.Number(2),
})

Initializer ​

ts
new StateTransitionMetric()
python
StateTransitionMetric()
java
new StateTransitionMetric()
csharp
new StateTransitionMetric()
go
NewStateTransitionMetric()

Methods ​

metric(metricName: string, props?: MetricOptions): Metric@staticmethod def metric(metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metric(String metricName, MetricOptions props)public static Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metricstatic#
Return the given named metric for the service's state transition metrics.
metricConsumedCapacity(props?: MetricOptions): Metric@staticmethod def metric_consumed_capacity(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricConsumedCapacity(MetricOptions props)public static Metric MetricConsumedCapacity(MetricOptions? props = null)func MetricConsumedCapacity(Props MetricOptions) Metricstatic#
Metric for the number of available state transitions per second.
metricProvisionedBucketSize(props?: MetricOptions): Metric@staticmethod def metric_provisioned_bucket_size(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricProvisionedBucketSize(MetricOptions props)public static Metric MetricProvisionedBucketSize(MetricOptions? props = null)func MetricProvisionedBucketSize(Props MetricOptions) Metricstatic#
Metric for the number of available state transitions.
metricProvisionedRefillRate(props?: MetricOptions): Metric@staticmethod def metric_provisioned_refill_rate(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricProvisionedRefillRate(MetricOptions props)public static Metric MetricProvisionedRefillRate(MetricOptions? props = null)func MetricProvisionedRefillRate(Props MetricOptions) Metricstatic#
Metric for the provisioned steady-state execution rate.
metricThrottledEvents(props?: MetricOptions): Metric@staticmethod def metric_throttled_events(props: typing.Optional[MetricOptions] = None) -> Metricpublic static Metric metricThrottledEvents(MetricOptions props)public static Metric MetricThrottledEvents(MetricOptions? props = null)func MetricThrottledEvents(Props MetricOptions) Metricstatic#
Metric for the number of throttled state transitions.