software.amazon.awscdk.services.stepfunctions

Class Activity

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.stepfunctions.Activity

All Implemented Interfaces:

IResource, IActivity, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.370Z")
 @Stability(value=Stable)
public class Activity
extends Resource
implements IActivity

Define a new Step Functions Activity.

Example:

 Activity activity = new Activity(this, "Activity");
 Role role = Role.Builder.create(this, "Role")
         .assumedBy(new ServicePrincipal("lambda.amazonaws.com"))
         .build();
 activity.grant(role, "states:SendTaskSuccess");
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	Activity(software.constructs.Construct scope, String id)
	Activity(software.constructs.Construct scope, String id, ActivityProps props)
protected	Activity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Activity(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IActivity	fromActivityArn(software.constructs.Construct scope, String id, String activityArn) Construct an Activity from an existing Activity ARN.
static IActivity	fromActivityName(software.constructs.Construct scope, String id, String activityName) Construct an Activity from an existing Activity Name.
String	getActivityArn() The ARN of the activity.
String	getActivityName() The name of the activity.
Grant	grant(IGrantable identity, String... actions) Grant the given identity permissions on this Activity.
Metric	metric(String metricName) Return the given named metric for this Activity.
Metric	metric(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.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Activity

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

Activity

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

Activity

@Stability(value=Stable)
public Activity(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @Nullable
                                         ActivityProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Activity

@Stability(value=Stable)
public Activity(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromActivityArn

@Stability(value=Stable)
 @NotNull
public static IActivity fromActivityArn(@NotNull
                                                                           software.constructs.Construct scope,
                                                                           @NotNull
                                                                           String id,
                                                                           @NotNull
                                                                           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

@Stability(value=Stable)
 @NotNull
public static IActivity fromActivityName(@NotNull
                                                                            software.constructs.Construct scope,
                                                                            @NotNull
                                                                            String id,
                                                                            @NotNull
                                                                            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

@Stability(value=Stable)
 @NotNull
public Grant grant(@NotNull
                                                      IGrantable identity,
                                                      @NotNull
                                                      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

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        MetricOptions props)

Return the given named metric for this Activity.

Default: sum over 5 minutes

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)

Return the given named metric for this Activity.

Default: sum over 5 minutes

Parameters:

metricName - This parameter is required.

metricFailed

@Stability(value=Stable)
 @NotNull
public Metric metricFailed(@Nullable
                                                              MetricOptions props)

Metric for the number of times this activity fails.

Default: sum over 5 minutes

Parameters:

props -

metricFailed

@Stability(value=Stable)
 @NotNull
public Metric metricFailed()

Metric for the number of times this activity fails.

Default: sum over 5 minutes

metricHeartbeatTimedOut

@Stability(value=Stable)
 @NotNull
public Metric metricHeartbeatTimedOut(@Nullable
                                                                         MetricOptions props)

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

Default: sum over 5 minutes

Parameters:

props -

metricHeartbeatTimedOut

@Stability(value=Stable)
 @NotNull
public Metric metricHeartbeatTimedOut()

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

Default: sum over 5 minutes

metricRunTime

@Stability(value=Stable)
 @NotNull
public Metric metricRunTime(@Nullable
                                                               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

@Stability(value=Stable)
 @NotNull
public Metric metricRunTime()

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

Default: average over 5 minutes

metricScheduled

@Stability(value=Stable)
 @NotNull
public Metric metricScheduled(@Nullable
                                                                 MetricOptions props)

Metric for the number of times this activity is scheduled.

Default: sum over 5 minutes

Parameters:

props -

metricScheduled

@Stability(value=Stable)
 @NotNull
public Metric metricScheduled()

Metric for the number of times this activity is scheduled.

Default: sum over 5 minutes

metricScheduleTime

@Stability(value=Stable)
 @NotNull
public Metric metricScheduleTime(@Nullable
                                                                    MetricOptions props)

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

Default: average over 5 minutes

Parameters:

props -

metricScheduleTime

@Stability(value=Stable)
 @NotNull
public Metric metricScheduleTime()

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

Default: average over 5 minutes

metricStarted

@Stability(value=Stable)
 @NotNull
public Metric metricStarted(@Nullable
                                                               MetricOptions props)

Metric for the number of times this activity is started.

Default: sum over 5 minutes

Parameters:

props -

metricStarted

@Stability(value=Stable)
 @NotNull
public Metric metricStarted()

Metric for the number of times this activity is started.

Default: sum over 5 minutes

metricSucceeded

@Stability(value=Stable)
 @NotNull
public Metric metricSucceeded(@Nullable
                                                                 MetricOptions props)

Metric for the number of times this activity succeeds.

Default: sum over 5 minutes

Parameters:

props -

metricSucceeded

@Stability(value=Stable)
 @NotNull
public Metric metricSucceeded()

Metric for the number of times this activity succeeds.

Default: sum over 5 minutes

metricTime

@Stability(value=Stable)
 @NotNull
public Metric metricTime(@Nullable
                                                            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

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public Metric metricTimedOut(@Nullable
                                                                MetricOptions props)

Metric for the number of times this activity times out.

Default: sum over 5 minutes

Parameters:

props -

metricTimedOut

@Stability(value=Stable)
 @NotNull
public Metric metricTimedOut()

Metric for the number of times this activity times out.

Default: sum over 5 minutes

getActivityArn

@Stability(value=Stable)
 @NotNull
public String getActivityArn()

The ARN of the activity.

Specified by:

getActivityArn in interface IActivity

getActivityName

@Stability(value=Stable)
 @NotNull
public String getActivityName()

The name of the activity.

Specified by:

getActivityName in interface IActivity