Class StepFunctionsInvokeActivityJsonataProps

Properties for invoking an Activity worker using JSONata.

Inheritance

object

StepFunctionsInvokeActivityJsonataProps

Implements

IStepFunctionsInvokeActivityJsonataProps

ITaskStateJsonataBaseProps

IStateBaseProps

ITaskStateBaseOptions

IAssignableStateOptions

IJsonataStateOptions

IJsonataCommonOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.StepFunctions.Tasks

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class StepFunctionsInvokeActivityJsonataProps : IStepFunctionsInvokeActivityJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataStateOptions, IJsonataCommonOptions

Syntax (vb)

Public Class StepFunctionsInvokeActivityJsonataProps Implements IStepFunctionsInvokeActivityJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataStateOptions, IJsonataCommonOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.StepFunctions;
            using Amazon.CDK.AWS.StepFunctions.Tasks;

            Activity activity;
            var arguments_;
            var assign;
            var outputs;
            TaskRole taskRole;
            Timeout timeout;

            var stepFunctionsInvokeActivityJsonataProps = new StepFunctionsInvokeActivityJsonataProps {
                Activity = activity,

                // the properties below are optional
                Arguments = arguments_,
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                Credentials = new Credentials {
                    Role = taskRole
                },
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                StateName = "stateName",
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30)
            };

Synopsis

Constructors

StepFunctionsInvokeActivityJsonataProps()

Properties for invoking an Activity worker using JSONata.

Properties

Activity	Step Functions Activity to invoke.
Arguments	Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
Assign	Workflow variables to store in this step.
Comment	A comment describing this state.
Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
Heartbeat	(deprecated) Timeout for the heartbeat.
HeartbeatTimeout	Timeout for the heartbeat.
IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
Outputs	Used to specify and transform output from the state.
QueryLanguage	The name of the query language used by the state.
StateName	Optional name for this state.
TaskTimeout	Timeout for the task.
Timeout	(deprecated) Timeout for the task.

Constructors

StepFunctionsInvokeActivityJsonataProps()

Properties for invoking an Activity worker using JSONata.

public StepFunctionsInvokeActivityJsonataProps()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.StepFunctions;
            using Amazon.CDK.AWS.StepFunctions.Tasks;

            Activity activity;
            var arguments_;
            var assign;
            var outputs;
            TaskRole taskRole;
            Timeout timeout;

            var stepFunctionsInvokeActivityJsonataProps = new StepFunctionsInvokeActivityJsonataProps {
                Activity = activity,

                // the properties below are optional
                Arguments = arguments_,
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                Credentials = new Credentials {
                    Role = taskRole
                },
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                StateName = "stateName",
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30)
            };

Properties

Activity

Step Functions Activity to invoke.

public IActivity Activity { get; set; }

Property Value

IActivity

Remarks

ExampleMetadata: fixture=_generated

Arguments

Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

public object? Arguments { get; set; }

Property Value

object

Remarks

Default: - No arguments

See: https://docs.aws.amazon.com/step-functions/latest/dg/transforming-data.html

Assign

Workflow variables to store in this step.

public IDictionary<string, object>? Assign { get; set; }

Property Value

IDictionary<string, object>

Remarks

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

See: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

Comment

A comment describing this state.

public string? Comment { get; set; }

Property Value

string

Remarks

Default: No comment

Credentials

Credentials for an IAM Role that the State Machine assumes for executing the task.

public ICredentials? Credentials { get; set; }

Property Value

ICredentials

Remarks

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

Heartbeat

(deprecated) Timeout for the heartbeat.

[Obsolete("use `heartbeatTimeout`")]
public Duration? Heartbeat { get; set; }

Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

HeartbeatTimeout

Timeout for the heartbeat.

public Timeout? HeartbeatTimeout { get; set; }

Property Value

Timeout

Remarks

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

IntegrationPattern

AWS Step Functions integrates with services directly in the Amazon States Language.

public IntegrationPattern? IntegrationPattern { get; set; }

Property Value

IntegrationPattern?

Remarks

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

Outputs

Used to specify and transform output from the state.

public object? Outputs { get; set; }

Property Value

object

Remarks

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

QueryLanguage

The name of the query language used by the state.

public QueryLanguage? QueryLanguage { get; set; }

Property Value

QueryLanguage?

Remarks

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

StateName

Optional name for this state.

public string? StateName { get; set; }

Property Value

string

Remarks

Default: - The construct ID will be used as state name

TaskTimeout

Timeout for the task.

public Timeout? TaskTimeout { get; set; }

Property Value

Timeout

Remarks

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Timeout

(deprecated) Timeout for the task.

[Obsolete("use `taskTimeout`")]
public Duration? Timeout { get; set; }

Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

Implements

IStepFunctionsInvokeActivityJsonataProps

ITaskStateJsonataBaseProps

IStateBaseProps

ITaskStateBaseOptions

IAssignableStateOptions

IJsonataStateOptions

IJsonataCommonOptions