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.103.1 (build bef2dea)",
date="2024-10-05T03:43:51.892Z")
@Stability(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/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
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
Activity
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Activity
(software.amazon.jsii.JsiiObjectRef objRef) Activity
(software.constructs.Construct scope, String id, ActivityProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic 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.The ARN of the activity.The name of the activity.The encryptionConfiguration object used for server-side encryption of the activity inputs.grant
(IGrantable identity, @NotNull String... actions) Grant the given identity permissions on this Activity.Return the given named metric for this Activity.metric
(String metricName, MetricOptions props) Return the given named metric for this Activity.Metric for the number of times this activity fails.metricFailed
(MetricOptions props) Metric for the number of times this activity fails.Metric for the number of times the heartbeat times out for this activity.Metric for the number of times the heartbeat times out for this activity.The interval, in milliseconds, between the time the activity starts and the time it closes.metricRunTime
(MetricOptions props) The interval, in milliseconds, between the time the activity starts and the time it closes.Metric for the number of times this activity is scheduled.metricScheduled
(MetricOptions props) Metric for the number of times this activity is scheduled.The interval, in milliseconds, for which the activity stays in the schedule state.metricScheduleTime
(MetricOptions props) The interval, in milliseconds, for which the activity stays in the schedule state.Metric for the number of times this activity is started.metricStarted
(MetricOptions props) Metric for the number of times this activity is started.Metric for the number of times this activity succeeds.metricSucceeded
(MetricOptions props) Metric for the number of times this activity succeeds.The interval, in milliseconds, between the time the activity is scheduled and the time it closes.metricTime
(MetricOptions props) The interval, in milliseconds, between the time the activity is scheduled and the time it closes.Metric for the number of times this activity times out.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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Activity
protected Activity(software.amazon.jsii.JsiiObjectRef objRef) -
Activity
protected Activity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Activity
@Stability(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(Stable) public Activity(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.
-
-
Method Details
-
fromActivityArn
@Stability(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(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(Stable) @NotNull public Grant grant(@NotNull IGrantable identity, @NotNull @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(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
Return the given named metric for this Activity.Default: sum over 5 minutes
- Parameters:
metricName
- This parameter is required.
-
metricFailed
Metric for the number of times this activity fails.Default: sum over 5 minutes
- Parameters:
props
-
-
metricFailed
Metric for the number of times this activity fails.Default: sum over 5 minutes
-
metricHeartbeatTimedOut
Metric for the number of times the heartbeat times out for this activity.Default: sum over 5 minutes
- Parameters:
props
-
-
metricHeartbeatTimedOut
Metric for the number of times the heartbeat times out for this activity.Default: sum over 5 minutes
-
metricRunTime
The interval, in milliseconds, between the time the activity starts and the time it closes.Default: average over 5 minutes
- Parameters:
props
-
-
metricRunTime
The interval, in milliseconds, between the time the activity starts and the time it closes.Default: average over 5 minutes
-
metricScheduled
Metric for the number of times this activity is scheduled.Default: sum over 5 minutes
- Parameters:
props
-
-
metricScheduled
Metric for the number of times this activity is scheduled.Default: sum over 5 minutes
-
metricScheduleTime
The interval, in milliseconds, for which the activity stays in the schedule state.Default: average over 5 minutes
- Parameters:
props
-
-
metricScheduleTime
The interval, in milliseconds, for which the activity stays in the schedule state.Default: average over 5 minutes
-
metricStarted
Metric for the number of times this activity is started.Default: sum over 5 minutes
- Parameters:
props
-
-
metricStarted
Metric for the number of times this activity is started.Default: sum over 5 minutes
-
metricSucceeded
Metric for the number of times this activity succeeds.Default: sum over 5 minutes
- Parameters:
props
-
-
metricSucceeded
Metric for the number of times this activity succeeds.Default: sum over 5 minutes
-
metricTime
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.Default: average over 5 minutes
- Parameters:
props
-
-
metricTime
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.Default: average over 5 minutes
-
metricTimedOut
Metric for the number of times this activity times out.Default: sum over 5 minutes
- Parameters:
props
-
-
metricTimedOut
Metric for the number of times this activity times out.Default: sum over 5 minutes
-
getActivityArn
The ARN of the activity.- Specified by:
getActivityArn
in interfaceIActivity
-
getActivityName
The name of the activity.- Specified by:
getActivityName
in interfaceIActivity
-
getEncryptionConfiguration
The encryptionConfiguration object used for server-side encryption of the activity inputs.- Specified by:
getEncryptionConfiguration
in interfaceIActivity
-