software.amazon.awscdk.services.stepfunctions

Class Activity

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.stepfunctions.Activity

All Implemented Interfaces:

IConstruct, IDependable, IResource, IActivity

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.436Z")
public class Activity
extends Resource
implements IActivity

Define a new Step Functions Activity.

Example:

 Activity activity = new Activity(this, "Activity");
 // Read this CloudFormation Output from your application and use it to poll for work on
 // the activity.
 // Read this CloudFormation Output from your application and use it to poll for work on
 // the activity.
 CfnOutput.Builder.create(this, "ActivityArn").value(activity.getActivityArn()).build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Activity.Builder A fluent builder for Activity.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IActivity

IActivity.Jsii$Default, IActivity.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Activity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Activity(software.amazon.jsii.JsiiObjectRef objRef)
	Activity(software.constructs.Construct scope, java.lang.String id)
	Activity(software.constructs.Construct scope, java.lang.String id, ActivityProps props)

Method Summary

Modifier and Type	Method and Description
static IActivity	fromActivityArn(software.constructs.Construct scope, java.lang.String id, java.lang.String activityArn) Construct an Activity from an existing Activity ARN.
static IActivity	fromActivityName(software.constructs.Construct scope, java.lang.String id, java.lang.String activityName) Construct an Activity from an existing Activity Name.
java.lang.String	getActivityArn() The ARN of the activity.
java.lang.String	getActivityName() The name of the activity.
Grant	grant(IGrantable identity, java.lang.String... actions) Grant the given identity permissions on this Activity.
Metric	metric(java.lang.String metricName) Return the given named metric for this Activity.
Metric	metric(java.lang.String metricName, MetricOptions props) Return the given named metric for this Activity.
Metric	metricFailed() Metric for the number of times this activity fails.
Metric	metricFailed(MetricOptions props) Metric for the number of times this activity fails.
Metric	metricHeartbeatTimedOut() Metric for the number of times the heartbeat times out for this activity.
Metric	metricHeartbeatTimedOut(MetricOptions props) Metric for the number of times the heartbeat times out for this activity.
Metric	metricRunTime() The interval, in milliseconds, between the time the activity starts and the time it closes.
Metric	metricRunTime(MetricOptions props) The interval, in milliseconds, between the time the activity starts and the time it closes.
Metric	metricScheduled() Metric for the number of times this activity is scheduled.
Metric	metricScheduled(MetricOptions props) Metric for the number of times this activity is scheduled.
Metric	metricScheduleTime() The interval, in milliseconds, for which the activity stays in the schedule state.
Metric	metricScheduleTime(MetricOptions props) The interval, in milliseconds, for which the activity stays in the schedule state.
Metric	metricStarted() Metric for the number of times this activity is started.
Metric	metricStarted(MetricOptions props) Metric for the number of times this activity is started.
Metric	metricSucceeded() Metric for the number of times this activity succeeds.
Metric	metricSucceeded(MetricOptions props) Metric for the number of times this activity succeeds.
Metric	metricTime() The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
Metric	metricTime(MetricOptions props) The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
Metric	metricTimedOut() Metric for the number of times this activity times out.
Metric	metricTimedOut(MetricOptions props) Metric for the number of times this activity times out.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Activity

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

Activity

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

Activity

public Activity(software.constructs.Construct scope,
                java.lang.String id,
                ActivityProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Activity

public Activity(software.constructs.Construct scope,
                java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromActivityArn

public static IActivity fromActivityArn(software.constructs.Construct scope,
                                        java.lang.String id,
                                        java.lang.String activityArn)

Construct an Activity from an existing Activity ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

activityArn - This parameter is required.

fromActivityName

public static IActivity fromActivityName(software.constructs.Construct scope,
                                         java.lang.String id,
                                         java.lang.String activityName)

Construct an Activity from an existing Activity Name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

activityName - This parameter is required.

grant

public Grant grant(IGrantable identity,
                   java.lang.String... actions)

Grant the given identity permissions on this Activity.

Parameters:

identity - The principal. This parameter is required.

actions - The list of desired actions. This parameter is required.

metric

public Metric metric(java.lang.String metricName,
                     MetricOptions props)

Return the given named metric for this Activity.

Default: sum over 5 minutes

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

Return the given named metric for this Activity.

Default: sum over 5 minutes

Parameters:

metricName - This parameter is required.

metricFailed

public Metric metricFailed(MetricOptions props)

Metric for the number of times this activity fails.

Default: sum over 5 minutes

Parameters:

props -

metricFailed

public Metric metricFailed()

Metric for the number of times this activity fails.

Default: sum over 5 minutes

metricHeartbeatTimedOut

public Metric metricHeartbeatTimedOut(MetricOptions props)

Metric for the number of times the heartbeat times out for this activity.

Default: sum over 5 minutes

Parameters:

props -

metricHeartbeatTimedOut

public Metric metricHeartbeatTimedOut()

Metric for the number of times the heartbeat times out for this activity.

Default: sum over 5 minutes

metricRunTime

public Metric metricRunTime(MetricOptions props)

The interval, in milliseconds, between the time the activity starts and the time it closes.

Default: average over 5 minutes

Parameters:

props -

metricRunTime

public Metric metricRunTime()

The interval, in milliseconds, between the time the activity starts and the time it closes.

Default: average over 5 minutes

metricScheduled

public Metric metricScheduled(MetricOptions props)

Metric for the number of times this activity is scheduled.

Default: sum over 5 minutes

Parameters:

props -

metricScheduled

public Metric metricScheduled()

Metric for the number of times this activity is scheduled.

Default: sum over 5 minutes

metricScheduleTime

public Metric metricScheduleTime(MetricOptions props)

The interval, in milliseconds, for which the activity stays in the schedule state.

Default: average over 5 minutes

Parameters:

props -

metricScheduleTime

public Metric metricScheduleTime()

The interval, in milliseconds, for which the activity stays in the schedule state.

Default: average over 5 minutes

metricStarted

public Metric metricStarted(MetricOptions props)

Metric for the number of times this activity is started.

Default: sum over 5 minutes

Parameters:

props -

metricStarted

public Metric metricStarted()

Metric for the number of times this activity is started.

Default: sum over 5 minutes

metricSucceeded

public Metric metricSucceeded(MetricOptions props)

Metric for the number of times this activity succeeds.

Default: sum over 5 minutes

Parameters:

props -

metricSucceeded

public Metric metricSucceeded()

Metric for the number of times this activity succeeds.

Default: sum over 5 minutes

metricTime

public Metric metricTime(MetricOptions props)

The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

Default: average over 5 minutes

Parameters:

props -

metricTime

public Metric metricTime()

The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

Default: average over 5 minutes

metricTimedOut

public Metric metricTimedOut(MetricOptions props)

Metric for the number of times this activity times out.

Default: sum over 5 minutes

Parameters:

props -

metricTimedOut

public Metric metricTimedOut()

Metric for the number of times this activity times out.

Default: sum over 5 minutes

getActivityArn

public java.lang.String getActivityArn()

The ARN of the activity.

Specified by:

getActivityArn in interface IActivity

getActivityName

public java.lang.String getActivityName()

The name of the activity.

Specified by:

getActivityName in interface IActivity