Class EmrContainersStartJobRunJsonataProps

public class EmrContainersStartJobRunJsonataProps : IEmrContainersStartJobRunJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptions

Syntax (vb)

Public Class EmrContainersStartJobRunJsonataProps Implements IEmrContainersStartJobRunJsonataProps, 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.IAM;
            using Amazon.CDK.AWS.Logs;
            using Amazon.CDK.AWS.S3;
            using Amazon.CDK.AWS.StepFunctions;
            using Amazon.CDK.AWS.StepFunctions.Tasks;

            ApplicationConfiguration applicationConfiguration_;
            var assign;
            Bucket bucket;
            Classification classification;
            LogGroup logGroup;
            var outputs;
            ReleaseLabel releaseLabel;
            Role role;
            TaskInput taskInput;
            TaskRole taskRole;
            Timeout timeout;
            VirtualClusterInput virtualClusterInput;

            var emrContainersStartJobRunJsonataProps = new EmrContainersStartJobRunJsonataProps {
                JobDriver = new JobDriver {
                    SparkSubmitJobDriver = new SparkSubmitJobDriver {
                        EntryPoint = taskInput,

                        // the properties below are optional
                        EntryPointArguments = taskInput,
                        SparkSubmitParameters = "sparkSubmitParameters"
                    }
                },
                ReleaseLabel = releaseLabel,
                VirtualCluster = virtualClusterInput,

                // the properties below are optional
                ApplicationConfig = new [] { new ApplicationConfiguration {
                    Classification = classification,

                    // the properties below are optional
                    NestedConfig = new [] { applicationConfiguration_ },
                    Properties = new Dictionary<string, string> {
                        { "propertiesKey", "properties" }
                    }
                } },
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                Credentials = new Credentials {
                    Role = taskRole
                },
                ExecutionRole = role,
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                JobName = "jobName",
                Monitoring = new Monitoring {
                    LogBucket = bucket,
                    Logging = false,
                    LogGroup = logGroup,
                    LogStreamNamePrefix = "logStreamNamePrefix",
                    PersistentAppUI = false
                },
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                StateName = "stateName",
                Tags = new Dictionary<string, string> {
                    { "tagsKey", "tags" }
                },
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30)
            };

Synopsis

Constructors

EmrContainersStartJobRunJsonataProps()

Properties for calling EMR Containers StartJobRun using JSONata.

Properties

ApplicationConfig	The configurations for the application running in the job run.
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.
ExecutionRole	The execution role for the job run.
Heartbeat	(deprecated) Timeout for the heartbeat.
HeartbeatTimeout	Timeout for the heartbeat.
IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
JobDriver	The job driver for the job run.
JobName	The name of the job run.
Monitoring	Configuration for monitoring the job run.
Outputs	Used to specify and transform output from the state.
QueryLanguage	The name of the query language used by the state.
ReleaseLabel	The Amazon EMR release version to use for the job run.
StateName	Optional name for this state.
Tags	The tags assigned to job runs.
TaskTimeout	Timeout for the task.
Timeout	(deprecated) Timeout for the task.
VirtualCluster	The ID of the virtual cluster where the job will be run.

Constructors

EmrContainersStartJobRunJsonataProps()

Properties for calling EMR Containers StartJobRun using JSONata.

public EmrContainersStartJobRunJsonataProps()

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.IAM;
            using Amazon.CDK.AWS.Logs;
            using Amazon.CDK.AWS.S3;
            using Amazon.CDK.AWS.StepFunctions;
            using Amazon.CDK.AWS.StepFunctions.Tasks;

            ApplicationConfiguration applicationConfiguration_;
            var assign;
            Bucket bucket;
            Classification classification;
            LogGroup logGroup;
            var outputs;
            ReleaseLabel releaseLabel;
            Role role;
            TaskInput taskInput;
            TaskRole taskRole;
            Timeout timeout;
            VirtualClusterInput virtualClusterInput;

            var emrContainersStartJobRunJsonataProps = new EmrContainersStartJobRunJsonataProps {
                JobDriver = new JobDriver {
                    SparkSubmitJobDriver = new SparkSubmitJobDriver {
                        EntryPoint = taskInput,

                        // the properties below are optional
                        EntryPointArguments = taskInput,
                        SparkSubmitParameters = "sparkSubmitParameters"
                    }
                },
                ReleaseLabel = releaseLabel,
                VirtualCluster = virtualClusterInput,

                // the properties below are optional
                ApplicationConfig = new [] { new ApplicationConfiguration {
                    Classification = classification,

                    // the properties below are optional
                    NestedConfig = new [] { applicationConfiguration_ },
                    Properties = new Dictionary<string, string> {
                        { "propertiesKey", "properties" }
                    }
                } },
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                Credentials = new Credentials {
                    Role = taskRole
                },
                ExecutionRole = role,
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                JobName = "jobName",
                Monitoring = new Monitoring {
                    LogBucket = bucket,
                    Logging = false,
                    LogGroup = logGroup,
                    LogStreamNamePrefix = "logStreamNamePrefix",
                    PersistentAppUI = false
                },
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                StateName = "stateName",
                Tags = new Dictionary<string, string> {
                    { "tagsKey", "tags" }
                },
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30)
            };

Properties

ApplicationConfig

The configurations for the application running in the job run.

public IApplicationConfiguration[]? ApplicationConfig { get; set; }

Property Value

IApplicationConfiguration[]

Remarks

Maximum of 100 items

Default: - No application config

See: https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_Configuration.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

ExecutionRole

The execution role for the job run.

public IRole? ExecutionRole { get; set; }

Property Value

IRole

Remarks

If virtualClusterId is from a JSON input path, an execution role must be provided. If an execution role is provided, follow the documentation to update the role trust policy.

Default: - Automatically generated only when the provided virtualClusterId is not an encoded JSON path

See: https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/setting-up-trust-policy.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

JobDriver

The job driver for the job run.

public IJobDriver JobDriver { get; set; }

Property Value

IJobDriver

Remarks

See: https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_JobDriver.html

JobName

The name of the job run.

public string? JobName { get; set; }

Property Value

string

Remarks

Default: - No job run name

Monitoring

Configuration for monitoring the job run.

public IMonitoring? Monitoring { get; set; }

Property Value

IMonitoring

Remarks

Default: - logging enabled and resources automatically generated if monitoring.logging is set to true

See: https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_MonitoringConfiguration.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

ReleaseLabel

The Amazon EMR release version to use for the job run.

public ReleaseLabel ReleaseLabel { get; set; }

Property Value

ReleaseLabel

Remarks

ExampleMetadata: fixture=_generated

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

VirtualCluster

The ID of the virtual cluster where the job will be run.

public VirtualClusterInput VirtualCluster { get; set; }

Property Value

VirtualClusterInput

Remarks

ExampleMetadata: fixture=_generated

Implements

IEmrContainersStartJobRunJsonataProps

ITaskStateJsonataBaseProps

IStateBaseProps

ITaskStateBaseOptions

IAssignableStateOptions

IJsonataCommonOptions