Class EmrContainersStartJobRunProps
The props for a EMR Containers StartJobRun Task.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EmrContainersStartJobRunProps : Object, IEmrContainersStartJobRunProps, ITaskStateBaseProps
Syntax (vb)
Public Class EmrContainersStartJobRunProps
Inherits Object
Implements IEmrContainersStartJobRunProps, ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
new EmrContainersStartJobRun(this, "EMR Containers Start Job Run", new EmrContainersStartJobRunProps {
VirtualCluster = VirtualClusterInput.FromVirtualClusterId("de92jdei2910fwedz"),
ReleaseLabel = ReleaseLabel.EMR_6_2_0,
JobName = "EMR-Containers-Job",
JobDriver = new JobDriver {
SparkSubmitJobDriver = new SparkSubmitJobDriver {
EntryPoint = TaskInput.FromText("local:///usr/lib/spark/examples/src/main/python/pi.py")
}
},
ApplicationConfig = new [] { new ApplicationConfiguration {
Classification = Classification.SPARK_DEFAULTS,
Properties = new Dictionary<string, string> {
{ "spark.executor.instances", "1" },
{ "spark.executor.memory", "512M" }
}
} }
});
Synopsis
Constructors
EmrContainersStartJobRunProps() |
Properties
ApplicationConfig | The configurations for the application running in the job run. |
Comment | An optional description for 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. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
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. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
ReleaseLabel | The Amazon EMR release version to use for the job run. |
ResultPath | JSONPath expression to indicate where to inject the state's output. |
ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
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
EmrContainersStartJobRunProps()
public EmrContainersStartJobRunProps()
Properties
ApplicationConfig
The configurations for the application running in the job run.
public IApplicationConfiguration[] ApplicationConfig { get; set; }
Property Value
Remarks
Maximum of 100 items
Default: - No application config
See: https://docs.aws.amazon.com/emr-on-eks/latest/APIReference/API_Configuration.html
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.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
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
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.
public Duration Heartbeat { get; set; }
Property Value
Remarks
Default: - None
Stability: Deprecated
HeartbeatTimeout
Timeout for the heartbeat.
public Timeout HeartbeatTimeout { get; set; }
Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<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
Remarks
JobName
The name of the job run.
public string JobName { get; set; }
Property Value
System.String
Remarks
Default: - No job run name
Monitoring
Configuration for monitoring the job run.
public IMonitoring Monitoring { get; set; }
Property Value
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
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next state.
public string OutputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
ReleaseLabel
The Amazon EMR release version to use for the job run.
public ReleaseLabel ReleaseLabel { get; set; }
Property Value
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
StateName
Optional name for this state.
public string StateName { get; set; }
Property Value
System.String
Remarks
Default: - The construct ID will be used as state name
Tags
The tags assigned to job runs.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - None
TaskTimeout
Timeout for the task.
public Timeout TaskTimeout { get; set; }
Property Value
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.
public Duration Timeout { get; set; }
Property Value
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