Class EmrCancelStepJsonataProps

public class EmrCancelStepJsonataProps : IEmrCancelStepJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptions

Syntax (vb)

Public Class EmrCancelStepJsonataProps Implements IEmrCancelStepJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, 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;

            var assign;
            var outputs;
            TaskRole taskRole;
            Timeout timeout;

            var emrCancelStepJsonataProps = new EmrCancelStepJsonataProps {
                ClusterId = "clusterId",
                StepId = "stepId",

                // the properties below are optional
                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

EmrCancelStepJsonataProps()

Properties for calling an EMR CancelStep using JSONata from your state machine.

Properties

Assign	Workflow variables to store in this step.
ClusterId	The ClusterId to update.
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.
StepId	The StepId to cancel.
TaskTimeout	Timeout for the task.
Timeout	(deprecated) Timeout for the task.

Constructors

EmrCancelStepJsonataProps()

Properties for calling an EMR CancelStep using JSONata from your state machine.

public EmrCancelStepJsonataProps()

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;

            var assign;
            var outputs;
            TaskRole taskRole;
            Timeout timeout;

            var emrCancelStepJsonataProps = new EmrCancelStepJsonataProps {
                ClusterId = "clusterId",
                StepId = "stepId",

                // the properties below are optional
                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

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

ClusterId

The ClusterId to update.

public string ClusterId { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

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

StepId

The StepId to cancel.

public string StepId { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

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

IEmrCancelStepJsonataProps

ITaskStateJsonataBaseProps

IStateBaseProps

ITaskStateBaseOptions

IAssignableStateOptions

IJsonataCommonOptions