Package software.amazon.awscdk.services.glue

Class CfnJob.Builder

java.lang.Object

software.amazon.awscdk.services.glue.CfnJob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJob>

Enclosing class:

CfnJob

@Stability(Stable)
public static final class CfnJob.Builder
extends Object
implements software.amazon.jsii.Builder<CfnJob>

A fluent builder for CfnJob.

Method Summary

Modifier and Type	Method	Description
CfnJob.Builder	allocatedCapacity(Number allocatedCapacity)	This parameter is no longer supported.
CfnJob	build()
CfnJob.Builder	command(IResolvable command)	The code that executes a job.
CfnJob.Builder	command(CfnJob.JobCommandProperty command)	The code that executes a job.
CfnJob.Builder	connections(IResolvable connections)	The connections used for this job.
CfnJob.Builder	connections(CfnJob.ConnectionsListProperty connections)	The connections used for this job.
static CfnJob.Builder	create(software.constructs.Construct scope, String id)
CfnJob.Builder	defaultArguments(Object defaultArguments)	The default arguments for this job, specified as name-value pairs.
CfnJob.Builder	description(String description)	A description of the job.
CfnJob.Builder	executionClass(String executionClass)	Indicates whether the job is run with a standard or flexible execution class.
CfnJob.Builder	executionProperty(IResolvable executionProperty)	The maximum number of concurrent runs that are allowed for this job.
CfnJob.Builder	executionProperty(CfnJob.ExecutionPropertyProperty executionProperty)	The maximum number of concurrent runs that are allowed for this job.
CfnJob.Builder	glueVersion(String glueVersion)	Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
CfnJob.Builder	jobMode(String jobMode)	A mode that describes how a job was created.
CfnJob.Builder	jobRunQueuingEnabled(Boolean jobRunQueuingEnabled)	Specifies whether job run queuing is enabled for the job runs for this job.
CfnJob.Builder	jobRunQueuingEnabled(IResolvable jobRunQueuingEnabled)	Specifies whether job run queuing is enabled for the job runs for this job.
CfnJob.Builder	logUri(String logUri)	This field is reserved for future use.
CfnJob.Builder	maintenanceWindow(String maintenanceWindow)	This field specifies a day of the week and hour for a maintenance window for streaming jobs.
CfnJob.Builder	maxCapacity(Number maxCapacity)	The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
CfnJob.Builder	maxRetries(Number maxRetries)	The maximum number of times to retry this job after a JobRun fails.
CfnJob.Builder	name(String name)	The name you assign to this job definition.
CfnJob.Builder	nonOverridableArguments(Object nonOverridableArguments)	Non-overridable arguments for this job, specified as name-value pairs.
CfnJob.Builder	notificationProperty(IResolvable notificationProperty)	Specifies configuration properties of a notification.
CfnJob.Builder	notificationProperty(CfnJob.NotificationPropertyProperty notificationProperty)	Specifies configuration properties of a notification.
CfnJob.Builder	numberOfWorkers(Number numberOfWorkers)	The number of workers of a defined workerType that are allocated when a job runs.
CfnJob.Builder	role(String role)	The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
CfnJob.Builder	securityConfiguration(String securityConfiguration)	The name of the SecurityConfiguration structure to be used with this job.
CfnJob.Builder	tags(Object tags)	The tags to use with this job.
CfnJob.Builder	timeout(Number timeout)	The job timeout in minutes.
CfnJob.Builder	workerType(String workerType)	The type of predefined worker that is allocated when a job runs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnJob.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnJob.Builder.

command

@Stability(Stable)
public CfnJob.Builder command(IResolvable command)

The code that executes a job.

Parameters:

command - The code that executes a job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-command

command

@Stability(Stable)
public CfnJob.Builder command(CfnJob.JobCommandProperty command)

The code that executes a job.

Parameters:

command - The code that executes a job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-command

role

@Stability(Stable)
public CfnJob.Builder role(String role)

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

Parameters:

role - The name or Amazon Resource Name (ARN) of the IAM role associated with this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-role

allocatedCapacity

@Stability(Stable)
public CfnJob.Builder allocatedCapacity(Number allocatedCapacity)

This parameter is no longer supported. Use MaxCapacity instead.

The number of capacity units that are allocated to this job.

Parameters:

allocatedCapacity - This parameter is no longer supported. Use MaxCapacity instead. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-allocatedcapacity

connections

@Stability(Stable)
public CfnJob.Builder connections(IResolvable connections)

The connections used for this job.

Parameters:

connections - The connections used for this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-connections

connections

@Stability(Stable)
public CfnJob.Builder connections(CfnJob.ConnectionsListProperty connections)

The connections used for this job.

Parameters:

connections - The connections used for this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-connections

defaultArguments

@Stability(Stable)
public CfnJob.Builder defaultArguments(Object defaultArguments)

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes.

For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python in the AWS Glue Developer Guide .

For information about the key-value pairs that AWS Glue consumes to set up your job, see Special Parameters Used by AWS Glue in the AWS Glue Developer Guide .

Parameters:

defaultArguments - The default arguments for this job, specified as name-value pairs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-defaultarguments

description

@Stability(Stable)
public CfnJob.Builder description(String description)

A description of the job.

Parameters:

description - A description of the job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-description

executionClass

@Stability(Stable)
public CfnJob.Builder executionClass(String executionClass)

Indicates whether the job is run with a standard or flexible execution class.

The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

Only jobs with AWS Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

Parameters:

executionClass - Indicates whether the job is run with a standard or flexible execution class. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionclass

executionProperty

@Stability(Stable)
public CfnJob.Builder executionProperty(IResolvable executionProperty)

The maximum number of concurrent runs that are allowed for this job.

Parameters:

executionProperty - The maximum number of concurrent runs that are allowed for this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionproperty

executionProperty

@Stability(Stable)
public CfnJob.Builder executionProperty(CfnJob.ExecutionPropertyProperty executionProperty)

The maximum number of concurrent runs that are allowed for this job.

Parameters:

executionProperty - The maximum number of concurrent runs that are allowed for this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionproperty

glueVersion

@Stability(Stable)
public CfnJob.Builder glueVersion(String glueVersion)

Glue version determines the versions of Apache Spark and Python that AWS Glue supports.

The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to the latest Glue version available.

Parameters:

glueVersion - Glue version determines the versions of Apache Spark and Python that AWS Glue supports. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-glueversion

jobMode

@Stability(Stable)
public CfnJob.Builder jobMode(String jobMode)

A mode that describes how a job was created. Valid values are:.

• SCRIPT - The job was created using the AWS Glue Studio script editor.
• VISUAL - The job was created using the AWS Glue Studio visual editor.
• NOTEBOOK - The job was created using an interactive sessions notebook.

When the JobMode field is missing or null, SCRIPT is assigned as the default value.

Parameters:

jobMode - A mode that describes how a job was created. Valid values are:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-jobmode

jobRunQueuingEnabled

@Stability(Stable)
public CfnJob.Builder jobRunQueuingEnabled(Boolean jobRunQueuingEnabled)

Specifies whether job run queuing is enabled for the job runs for this job.

A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.

If this field does not match the value set in the job run, then the value from the job run field will be used.

Parameters:

jobRunQueuingEnabled - Specifies whether job run queuing is enabled for the job runs for this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-jobrunqueuingenabled

jobRunQueuingEnabled

@Stability(Stable)
public CfnJob.Builder jobRunQueuingEnabled(IResolvable jobRunQueuingEnabled)

Specifies whether job run queuing is enabled for the job runs for this job.

A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.

If this field does not match the value set in the job run, then the value from the job run field will be used.

Parameters:

jobRunQueuingEnabled - Specifies whether job run queuing is enabled for the job runs for this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-jobrunqueuingenabled

logUri

@Stability(Stable)
public CfnJob.Builder logUri(String logUri)

This field is reserved for future use.

Parameters:

logUri - This field is reserved for future use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-loguri

maintenanceWindow

@Stability(Stable)
public CfnJob.Builder maintenanceWindow(String maintenanceWindow)

This field specifies a day of the week and hour for a maintenance window for streaming jobs.

AWS Glue periodically performs maintenance activities. During these maintenance windows, AWS Glue will need to restart your streaming jobs.

AWS Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.

Parameters:

maintenanceWindow - This field specifies a day of the week and hour for a maintenance window for streaming jobs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maintenancewindow

maxCapacity

@Stability(Stable)
public CfnJob.Builder maxCapacity(Number maxCapacity)

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.

A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

Do not set Max Capacity if using WorkerType and NumberOfWorkers .

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

• When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
• When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

Parameters:

maxCapacity - The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxcapacity

maxRetries

@Stability(Stable)
public CfnJob.Builder maxRetries(Number maxRetries)

The maximum number of times to retry this job after a JobRun fails.

Parameters:

maxRetries - The maximum number of times to retry this job after a JobRun fails. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxretries

name

@Stability(Stable)
public CfnJob.Builder name(String name)

The name you assign to this job definition.

Parameters:

name - The name you assign to this job definition. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-name

nonOverridableArguments

@Stability(Stable)
public CfnJob.Builder nonOverridableArguments(Object nonOverridableArguments)

Non-overridable arguments for this job, specified as name-value pairs.

Parameters:

nonOverridableArguments - Non-overridable arguments for this job, specified as name-value pairs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-nonoverridablearguments

notificationProperty

@Stability(Stable)
public CfnJob.Builder notificationProperty(IResolvable notificationProperty)

Specifies configuration properties of a notification.

Parameters:

notificationProperty - Specifies configuration properties of a notification. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-notificationproperty

notificationProperty

@Stability(Stable)
public CfnJob.Builder notificationProperty(CfnJob.NotificationPropertyProperty notificationProperty)

Specifies configuration properties of a notification.

Parameters:

notificationProperty - Specifies configuration properties of a notification. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-notificationproperty

numberOfWorkers

@Stability(Stable)
public CfnJob.Builder numberOfWorkers(Number numberOfWorkers)

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

The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

Parameters:

numberOfWorkers - The number of workers of a defined workerType that are allocated when a job runs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-numberofworkers

securityConfiguration

@Stability(Stable)
public CfnJob.Builder securityConfiguration(String securityConfiguration)

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

Parameters:

securityConfiguration - The name of the SecurityConfiguration structure to be used with this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-securityconfiguration

tags

@Stability(Stable)
public CfnJob.Builder tags(Object tags)

The tags to use with this job.

Parameters:

tags - The tags to use with this job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-tags

timeout

@Stability(Stable)
public CfnJob.Builder timeout(Number timeout)

The job timeout in minutes.

This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Parameters:

timeout - The job timeout in minutes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-timeout

workerType

@Stability(Stable)
public CfnJob.Builder workerType(String workerType)

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

Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.

• For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
• For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
• For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs in the following AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
• For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs, in the same AWS Regions as supported for the G.4X worker type.
• For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for AWS Glue version 3.0 streaming jobs.
• For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.

Parameters:

workerType - The type of predefined worker that is allocated when a job runs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-workertype

build

@Stability(Stable)
public CfnJob build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnJob>

Returns:

a newly built instance of CfnJob.