Class Activity

Define a new Step Functions Activity.

Inheritance

System.Object

Resource

Activity

Implements

IActivity

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class Activity : Resource, IActivity, IResource

Syntax (vb)

Public Class Activity
    Inherits Resource
    Implements IActivity, IResource

Remarks

ExampleMetadata: infused

Examples

var activity = new Activity(this, "Activity");

var role = new Role(this, "Role", new RoleProps {
    AssumedBy = new ServicePrincipal("lambda.amazonaws.com")
});

activity.Grant(role, "states:SendTaskSuccess");

Synopsis

Constructors

Activity(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Activity(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
Activity(Construct, String, IActivityProps)

Properties

ActivityArn	The ARN of the activity.
ActivityName	The name of the activity.
EncryptionConfiguration	The encryptionConfiguration object used for server-side encryption of the activity inputs.

Methods

FromActivityArn(Construct, String, String)	Construct an Activity from an existing Activity ARN.
FromActivityName(Construct, String, String)	Construct an Activity from an existing Activity Name.
Grant(IGrantable, String[])	Grant the given identity permissions on this Activity.
Metric(String, IMetricOptions)	Return the given named metric for this Activity.
MetricFailed(IMetricOptions)	Metric for the number of times this activity fails.
MetricHeartbeatTimedOut(IMetricOptions)	Metric for the number of times the heartbeat times out for this activity.
MetricRunTime(IMetricOptions)	The interval, in milliseconds, between the time the activity starts and the time it closes.
MetricScheduled(IMetricOptions)	Metric for the number of times this activity is scheduled.
MetricScheduleTime(IMetricOptions)	The interval, in milliseconds, for which the activity stays in the schedule state.
MetricStarted(IMetricOptions)	Metric for the number of times this activity is started.
MetricSucceeded(IMetricOptions)	Metric for the number of times this activity succeeds.
MetricTime(IMetricOptions)	The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
MetricTimedOut(IMetricOptions)	Metric for the number of times this activity times out.

Constructors

Activity(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Activity(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

Activity(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Activity(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Activity(Construct, String, IActivityProps)

public Activity(Construct scope, string id, IActivityProps props = null)

Parameters

scope Constructs.Construct
id System.String
props IActivityProps

Properties

ActivityArn

The ARN of the activity.

public virtual string ActivityArn { get; }

Property Value

System.String

Remarks

Attribute: true

ActivityName

The name of the activity.

public virtual string ActivityName { get; }

Property Value

System.String

Remarks

Attribute: true

EncryptionConfiguration

The encryptionConfiguration object used for server-side encryption of the activity inputs.

public virtual EncryptionConfiguration EncryptionConfiguration { get; }

Property Value

EncryptionConfiguration

Remarks

Attribute: true

Methods

FromActivityArn(Construct, String, String)

Construct an Activity from an existing Activity ARN.

public static IActivity FromActivityArn(Construct scope, string id, string activityArn)

Parameters

scope Constructs.Construct
id System.String
activityArn System.String

Returns

IActivity

FromActivityName(Construct, String, String)

Construct an Activity from an existing Activity Name.

public static IActivity FromActivityName(Construct scope, string id, string activityName)

Parameters

scope Constructs.Construct
id System.String
activityName System.String

Returns

IActivity

Grant(IGrantable, String[])

Grant the given identity permissions on this Activity.

public virtual Grant Grant(IGrantable identity, params string[] actions)

Parameters

identity IGrantable: The principal.
actions System.String[]: The list of desired actions.

Returns

Grant

Metric(String, IMetricOptions)

Return the given named metric for this Activity.

public virtual Metric Metric(string metricName, IMetricOptions props = null)

Parameters

metricName System.String
props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

MetricFailed(IMetricOptions)

Metric for the number of times this activity fails.

public virtual Metric MetricFailed(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

MetricHeartbeatTimedOut(IMetricOptions)

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

public virtual Metric MetricHeartbeatTimedOut(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

MetricRunTime(IMetricOptions)

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

public virtual Metric MetricRunTime(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: average over 5 minutes

MetricScheduled(IMetricOptions)

Metric for the number of times this activity is scheduled.

public virtual Metric MetricScheduled(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

MetricScheduleTime(IMetricOptions)

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

public virtual Metric MetricScheduleTime(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: average over 5 minutes

MetricStarted(IMetricOptions)

Metric for the number of times this activity is started.

public virtual Metric MetricStarted(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

MetricSucceeded(IMetricOptions)

Metric for the number of times this activity succeeds.

public virtual Metric MetricSucceeded(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

MetricTime(IMetricOptions)

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

public virtual Metric MetricTime(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: average over 5 minutes

MetricTimedOut(IMetricOptions)

Metric for the number of times this activity times out.

public virtual Metric MetricTimedOut(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

Implements

IActivity

IResource

Constructs.IConstruct

Constructs.IDependable