Package software.amazon.awscdk.services.stepfunctions.tasks

Interface GlueStartJobRunProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

GlueStartJobRunProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:52.168Z")
@Stability(Stable)
public interface GlueStartJobRunProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for starting an AWS Glue job as a task.

Example:

 GlueStartJobRun.Builder.create(this, "Task")
         .glueJobName("my-glue-job")
         .workerConfiguration(WorkerConfigurationProperty.builder()
                 .workerType(WorkerType.G_1X) // Worker type
                 .numberOfWorkers(2)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GlueStartJobRunProps.Builder	A builder for GlueStartJobRunProps
static final class	GlueStartJobRunProps.Jsii$Proxy	An implementation for GlueStartJobRunProps

Method Summary

Modifier and Type	Method	Description
static GlueStartJobRunProps.Builder	builder()
default TaskInput	getArguments()	The job arguments specifically for this run.
default ExecutionClass	getExecutionClass()	The excecution class of the job.
String	getGlueJobName()	Glue job name.
default Duration	getNotifyDelayAfter()	After a job run starts, the number of minutes to wait before sending a job run delay notification.
default String	getSecurityConfiguration()	The name of the SecurityConfiguration structure to be used with this job run.
default WorkerConfigurationProperty	getWorkerConfiguration()	The worker configuration for this run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getGlueJobName

@Stability(Stable)
@NotNull
String getGlueJobName()

Glue job name.

getArguments

@Stability(Stable)
@Nullable
default TaskInput getArguments()

The job arguments specifically for this run.

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

Default: - Default arguments set in the job definition

getExecutionClass

@Stability(Stable)
@Nullable
default ExecutionClass getExecutionClass()

The excecution class of the job.

Default: - STANDARD

getNotifyDelayAfter

@Stability(Stable)
@Nullable
default Duration getNotifyDelayAfter()

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

Must be at least 1 minute.

Default: - Default delay set in the job definition

getSecurityConfiguration

@Stability(Stable)
@Nullable
default String getSecurityConfiguration()

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

This must match the Glue API

Default: - Default configuration set in the job definition

See Also:

• https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-oneLine

getWorkerConfiguration

@Stability(Stable)
@Nullable
default WorkerConfigurationProperty getWorkerConfiguration()

The worker configuration for this run.

Default: - Default worker configuration in the job definition

builder

@Stability(Stable)
static GlueStartJobRunProps.Builder builder()

Returns:

a GlueStartJobRunProps.Builder of GlueStartJobRunProps