Class GlueStartJobRunJsonataProps
Properties for starting an AWS Glue job as a task.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class GlueStartJobRunJsonataProps : Object, IGlueStartJobRunJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsSyntax (vb)
Public Class GlueStartJobRunJsonataProps
Inherits Object
Implements IGlueStartJobRunJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsRemarks
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;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
WorkerTypeV2 workerTypeV2;
var glueStartJobRunJsonataProps = new GlueStartJobRunJsonataProps {
GlueJobName = "glueJobName",
// the properties below are optional
Arguments = taskInput,
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
Credentials = new Credentials {
Role = taskRole
},
ExecutionClass = ExecutionClass.FLEX,
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
NotifyDelayAfter = Duration.Minutes(30),
Outputs = outputs,
QueryLanguage = QueryLanguage.JSON_PATH,
SecurityConfiguration = "securityConfiguration",
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30),
WorkerConfiguration = new WorkerConfigurationProperty {
NumberOfWorkers = 123,
// the properties below are optional
WorkerType = WorkerType.STANDARD,
WorkerTypeV2 = workerTypeV2
}
};Synopsis
Constructors
| Glue |
Properties
| Arguments | The job arguments specifically for this 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. |
| Execution |
The excecution class of the job. |
| Glue |
Glue job name. |
| Heartbeat | (deprecated) Timeout for the heartbeat. |
| Heartbeat |
Timeout for the heartbeat. |
| Integration |
AWS Step Functions integrates with services directly in the Amazon States Language. |
| Notify |
After a job run starts, the number of minutes to wait before sending a job run delay notification. |
| Outputs | Used to specify and transform output from the state. |
| Query |
The name of the query language used by the state. |
| Security |
The name of the SecurityConfiguration structure to be used with this job run. |
| State |
Optional name for this state. |
| Task |
Timeout for the task. |
| Timeout | (deprecated) Timeout for the task. |
| Worker |
The worker configuration for this run. |
Constructors
GlueStartJobRunJsonataProps()
public GlueStartJobRunJsonataProps()Properties
Arguments
The job arguments specifically for this run.
public TaskInput Arguments { get; set; }Property Value
Remarks
For this job run, they replace the default arguments set in the job definition itself.
Default: - Default arguments set in the job definition
Assign
Workflow variables to store in this step.
public IDictionary<string, object> Assign { get; set; }Property Value
System.
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
System.
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
ExecutionClass
The excecution class of the job.
public Nullable<ExecutionClass> ExecutionClass { get; set; }Property Value
System.
Remarks
Default: - STANDARD
GlueJobName
Glue job name.
public string GlueJobName { get; set; }Property Value
System.
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
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }Property Value
System.
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
NotifyDelayAfter
After a job run starts, the number of minutes to wait before sending a job run delay notification.
public Duration NotifyDelayAfter { get; set; }Property Value
Remarks
Must be at least 1 minute.
Default: - Default delay set in the job definition
Outputs
Used to specify and transform output from the state.
public object Outputs { get; set; }Property Value
System.
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 Nullable<QueryLanguage> QueryLanguage { get; set; }Property Value
System.
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
SecurityConfiguration
The name of the SecurityConfiguration structure to be used with this job run.
public string SecurityConfiguration { get; set; }Property Value
System.
Remarks
This must match the Glue API
Default: - Default configuration set in the job definition
See: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-oneLine
StateName
Optional name for this state.
public string StateName { get; set; }Property Value
System.
Remarks
Default: - The construct ID will be used as state name
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
WorkerConfiguration
The worker configuration for this run.
public IWorkerConfigurationProperty WorkerConfiguration { get; set; }Property Value
Remarks
Default: - Default worker configuration in the job definition