Interface IGlueStartJobRunJsonataProps

Properties for starting an AWS Glue job as a task.

Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IGlueStartJobRunJsonataProps : ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptions
Syntax (vb)
Public Interface IGlueStartJobRunJsonataProps
    Inherits 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;
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

Properties

Arguments

The job arguments specifically for this run.
ExecutionClass

The excecution class of the job.
GlueJobName

Glue job name.
NotifyDelayAfter

After a job run starts, the number of minutes to wait before sending a job run delay notification.
SecurityConfiguration

The name of the SecurityConfiguration structure to be used with this job run.
WorkerConfiguration

The worker configuration for this run.

Properties

Arguments

The job arguments specifically for this run.

virtual TaskInput Arguments { get; }
Property Value

TaskInput

Remarks

For this job run, they replace the default arguments set in the job definition itself.

Default: - Default arguments set in the job definition

ExecutionClass

The excecution class of the job.

virtual Nullable<ExecutionClass> ExecutionClass { get; }
Property Value

System.Nullable<ExecutionClass>

Remarks

Default: - STANDARD

GlueJobName

Glue job name.

string GlueJobName { get; }
Property Value

System.String

NotifyDelayAfter

After a job run starts, the number of minutes to wait before sending a job run delay notification.

virtual Duration NotifyDelayAfter { get; }
Property Value

Duration

Remarks

Must be at least 1 minute.

Default: - Default delay set in the job definition

SecurityConfiguration

The name of the SecurityConfiguration structure to be used with this job run.

virtual string SecurityConfiguration { get; }
Property Value

System.String

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

WorkerConfiguration

The worker configuration for this run.

virtual IWorkerConfigurationProperty WorkerConfiguration { get; }
Property Value

IWorkerConfigurationProperty

Remarks

Default: - Default worker configuration in the job definition