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

Interface WorkerConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WorkerConfigurationProperty.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:41:02.046Z")
@Stability(Stable)
public interface WorkerConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Properties for the worker configuration.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WorkerConfigurationProperty.Builder	builder()
Number	getNumberOfWorkers()	The number of workers of a defined WorkerType that are allocated when a job runs.
default WorkerType	getWorkerType()	Deprecated. Use workerTypeV2 for more flexibility in defining worker types.
default WorkerTypeV2	getWorkerTypeV2()	The type of predefined worker that is allocated when a job runs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNumberOfWorkers

@Stability(Stable)
@NotNull
Number getNumberOfWorkers()

The number of workers of a defined WorkerType that are allocated when a job runs.

getWorkerType

@Stability(Deprecated)
@Deprecated
@Nullable
default WorkerType getWorkerType()

Deprecated.

Use workerTypeV2 for more flexibility in defining worker types.

(deprecated) The type of predefined worker that is allocated when a job runs.

Default: - must choose one of `workerType` or `workerTypeV2`

getWorkerTypeV2

@Stability(Stable)
@Nullable
default WorkerTypeV2 getWorkerTypeV2()

The type of predefined worker that is allocated when a job runs.

Can be one of the predefined values or dynamic values using WorkerTypeV2.of(...).

Default: - must choose one of `workerType` or `workerTypeV2`

builder

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

Returns:

a WorkerConfigurationProperty.Builder of WorkerConfigurationProperty