JobArgs class

The set of arguments for Job. The set of arguments for Job.

Constructors

JobArgs({required Input<JobCommand> command, Input<List<String>?>? connections, Input<Map<String, String>?>? defaultArguments, Input<String?>? description, Input<String?>? executionClass, Input<JobExecutionProperty?>? executionProperty, Input<String?>? glueVersion, Input<String?>? jobMode, Input<bool?>? jobRunQueuingEnabled, Input<String?>? maintenanceWindow, Input<double?>? maxCapacity, Input<int?>? maxRetries, Input<String?>? name, Input<Map<String, String>?>? nonOverridableArguments, Input<JobNotificationProperty?>? notificationProperty, Input<int?>? numberOfWorkers, Input<String?>? region, required Input<String> roleArn, Input<String?>? securityConfiguration, Input<JobSourceControlDetails?>? sourceControlDetails, Input<Map<String, String>?>? tags, Input<int?>? timeout, Input<String?>? workerType})
Creates a new JobArgs. command The command of the job. Defined below. connections The list of connections used for this job. defaultArguments The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide. description Description of the job. 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. Valid value: FLEX, STANDARD. executionProperty Execution property of the job. Defined below. glueVersion The version of glue to use, for example "1.0". Ray jobs should set this to 4.0 or greater. For information about available versions, see the AWS Glue Release Notes. jobMode Describes how a job was created. Valid values are SCRIPT, NOTEBOOK and VISUAL. 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. maintenanceWindow Specifies the day of the week and hour for the maintenance window for streaming jobs. maxCapacity The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. Required when pythonshell is set, accept either 0.0625 or 1.0. Use numberOfWorkers and workerType arguments instead with glueVersion 2.0 and above. maxRetries The maximum number of times to retry this job if it fails. name The name you assign to this job. It must be unique in your account. nonOverridableArguments Non-overridable arguments for this job, specified as name-value pairs. notificationProperty Notification property of the job. Defined below. numberOfWorkers The number of workers of a defined workerType that are allocated when a job runs. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn The ARN of the IAM role associated with this job. securityConfiguration The name of the Security Configuration to be associated with the job. sourceControlDetails The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository. Defined below. tags Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. timeout The job timeout in minutes. The default is 2880 minutes (48 hours) for glueetl and pythonshell jobs, and 0 (unlimited) for gluestreaming jobs. Leave this attribute argumnet unconfigured for glueray jobs. workerType The type of predefined worker that is allocated when a job runs. Valid values: Standard, G.1X, G.2X, G.025X, G.4X, G.8X, G.12X, G.16X, R.1X, R.2X, R.4X, R.8X, Z.2X (Ray jobs). See the AWS documentation for details.
const
JobArgs.fromMap(Map<String, dynamic> map)
factory

Properties

command → Input<JobCommand>
The command of the job. Defined below.
final
connections → Input<List<String>?>?
The list of connections used for this job.
final
defaultArguments → Input<Map<String, String>?>?
The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.
final
description → Input<String?>?
Description of the job.
final
executionClass → Input<String?>?
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. Valid value: FLEX, STANDARD.
final
executionProperty → Input<JobExecutionProperty?>?
Execution property of the job. Defined below.
final
glueVersion → Input<String?>?
The version of glue to use, for example "1.0". Ray jobs should set this to 4.0 or greater. For information about available versions, see the AWS Glue Release Notes.
final
hashCode → int
The hash code for this object.
no setterinherited
jobMode → Input<String?>?
Describes how a job was created. Valid values are SCRIPT, NOTEBOOK and VISUAL.
final
jobRunQueuingEnabled → Input<bool?>?
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.
final
maintenanceWindow → Input<String?>?
Specifies the day of the week and hour for the maintenance window for streaming jobs.
final
maxCapacity → Input<double?>?
The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. Required when pythonshell is set, accept either 0.0625 or 1.0. Use numberOfWorkers and workerType arguments instead with glueVersion 2.0 and above.
final
maxRetries → Input<int?>?
The maximum number of times to retry this job if it fails.
final
name → Input<String?>?
The name you assign to this job. It must be unique in your account.
final
nonOverridableArguments → Input<Map<String, String>?>?
Non-overridable arguments for this job, specified as name-value pairs.
final
notificationProperty → Input<JobNotificationProperty?>?
Notification property of the job. Defined below.
final
numberOfWorkers → Input<int?>?
The number of workers of a defined workerType that are allocated when a job runs.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String>
The ARN of the IAM role associated with this job.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityConfiguration → Input<String?>?
The name of the Security Configuration to be associated with the job.
final
sourceControlDetails → Input<JobSourceControlDetails?>?
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository. Defined below.
final
tags → Input<Map<String, String>?>?
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
timeout → Input<int?>?
The job timeout in minutes. The default is 2880 minutes (48 hours) for glueetl and pythonshell jobs, and 0 (unlimited) for gluestreaming jobs. Leave this attribute argumnet unconfigured for glueray jobs.
final
workerType → Input<String?>?
The type of predefined worker that is allocated when a job runs. Valid values: Standard, G.1X, G.2X, G.025X, G.4X, G.8X, G.12X, G.16X, R.1X, R.2X, R.4X, R.8X, Z.2X (Ray jobs). See the AWS documentation for details.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited