# Activity

Define a new Step Functions Activity.

Extends: Construct › Resource › Activity
Implements: IResource, IActivity, IEnvironmentAware, IActivityRef, IConstruct, IDependable

- CloudFormation: [`AWS::StepFunctions::Activity`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-stepfunctions-activity.html)
- L1 type: [`CfnActivity`](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.CfnActivity.html)
- Source: [`aws-stepfunctions/lib/activity.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-stepfunctions/lib/activity.ts#L38)
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

```ts
const activity = new sfn.Activity(this, 'Activity');

const role = new iam.Role(this, 'Role', {
  assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
});

activity.grant(role, 'states:SendTaskSuccess');
```

## Initializer

```ts
new Activity(scope: Construct, id: string, props?: ActivityProps)
```

## Construct Props

- `activityName`: string — The name for this activity.

  **Default:** If not supplied, a name is generated

- `encryptionConfiguration`: [EncryptionConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.EncryptionConfiguration.html) — The encryptionConfiguration object used for server-side encryption of the activity inputs.

  **Default:** data is transparently encrypted using an AWS owned key

## Properties

- `activityArn`: string — The ARN of the activity.

- `activityName`: string — The name of the activity.

- `activityRef`: [ActivityReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_stepfunctions.ActivityReference.html) — A reference to a Activity resource.

- `encryptionConfiguration`: [EncryptionConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.EncryptionConfiguration.html) — The encryptionConfiguration object used for server-side encryption of the activity inputs.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromActivityArn(scope: Construct, id: string, activityArn: string): IActivity` (static) — Construct an Activity from an existing Activity ARN.

- `fromActivityName(scope: Construct, id: string, activityName: string): IActivity` (static) — Construct an Activity from an existing Activity Name.

- `grant(identity: IGrantable, ...actions: string[]): Grant` — Grant the given identity permissions on this Activity.

  [disable-awslint:no-grants]

  **Parameters**

  - `identity` — The principal.
  - `actions` — The list of desired actions.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this Activity.

- `metricFailed(props?: MetricOptions): Metric` — Metric for the number of times this activity fails.

- `metricHeartbeatTimedOut(props?: MetricOptions): Metric` — Metric for the number of times the heartbeat times out for this activity.

- `metricRunTime(props?: MetricOptions): Metric` — The interval, in milliseconds, between the time the activity starts and the time it closes.

- `metricScheduled(props?: MetricOptions): Metric` — Metric for the number of times this activity is scheduled.

- `metricScheduleTime(props?: MetricOptions): Metric` — The interval, in milliseconds, for which the activity stays in the schedule state.

- `metricStarted(props?: MetricOptions): Metric` — Metric for the number of times this activity is started.

- `metricSucceeded(props?: MetricOptions): Metric` — Metric for the number of times this activity succeeds.

- `metricTime(props?: MetricOptions): Metric` — The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

- `metricTimedOut(props?: MetricOptions): Metric` — Metric for the number of times this activity times out.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.
