@Stability(value=Stable) public static final class CfnJobProps.Builder extends Object implements software.amazon.jsii.Builder<CfnJobProps>
CfnJobProps
Constructor and Description |
---|
Builder() |
@Stability(value=Stable) public CfnJobProps.Builder command(IResolvable command)
CfnJobProps.getCommand()
command
- The code that executes a job. This parameter is required.this
@Stability(value=Stable) public CfnJobProps.Builder command(CfnJob.JobCommandProperty command)
CfnJobProps.getCommand()
command
- The code that executes a job. This parameter is required.this
@Stability(value=Stable) public CfnJobProps.Builder role(String role)
CfnJobProps.getRole()
role
- The name or Amazon Resource Name (ARN) of the IAM role associated with this job. This parameter is required.this
@Stability(value=Stable) public CfnJobProps.Builder allocatedCapacity(Number allocatedCapacity)
CfnJobProps.getAllocatedCapacity()
allocatedCapacity
- This parameter is no longer supported. Use `MaxCapacity` instead.
The number of capacity units that are allocated to this job.this
@Stability(value=Stable) public CfnJobProps.Builder connections(IResolvable connections)
CfnJobProps.getConnections()
connections
- The connections used for this job.this
@Stability(value=Stable) public CfnJobProps.Builder connections(CfnJob.ConnectionsListProperty connections)
CfnJobProps.getConnections()
connections
- The connections used for this job.this
@Stability(value=Stable) public CfnJobProps.Builder defaultArguments(Object defaultArguments)
CfnJobProps.getDefaultArguments()
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 .
this
@Stability(value=Stable) public CfnJobProps.Builder description(String description)
CfnJobProps.getDescription()
description
- A description of the job.this
@Stability(value=Stable) public CfnJobProps.Builder executionClass(String executionClass)
CfnJobProps.getExecutionClass()
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.
this
@Stability(value=Stable) public CfnJobProps.Builder executionProperty(IResolvable executionProperty)
CfnJobProps.getExecutionProperty()
executionProperty
- The maximum number of concurrent runs that are allowed for this job.this
@Stability(value=Stable) public CfnJobProps.Builder executionProperty(CfnJob.ExecutionPropertyProperty executionProperty)
CfnJobProps.getExecutionProperty()
executionProperty
- The maximum number of concurrent runs that are allowed for this job.this
@Stability(value=Stable) public CfnJobProps.Builder glueVersion(String glueVersion)
CfnJobProps.getGlueVersion()
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 Glue 0.9.
this
@Stability(value=Stable) public CfnJobProps.Builder logUri(String logUri)
CfnJobProps.getLogUri()
logUri
- This field is reserved for future use.this
@Stability(value=Stable) public CfnJobProps.Builder maxCapacity(Number maxCapacity)
CfnJobProps.getMaxCapacity()
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:
JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.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.this
@Stability(value=Stable) public CfnJobProps.Builder maxRetries(Number maxRetries)
CfnJobProps.getMaxRetries()
maxRetries
- The maximum number of times to retry this job after a JobRun fails.this
@Stability(value=Stable) public CfnJobProps.Builder name(String name)
CfnJobProps.getName()
name
- The name you assign to this job definition.this
@Stability(value=Stable) public CfnJobProps.Builder nonOverridableArguments(Object nonOverridableArguments)
CfnJobProps.getNonOverridableArguments()
nonOverridableArguments
- Non-overridable arguments for this job, specified as name-value pairs.this
@Stability(value=Stable) public CfnJobProps.Builder notificationProperty(IResolvable notificationProperty)
CfnJobProps.getNotificationProperty()
notificationProperty
- Specifies configuration properties of a notification.this
@Stability(value=Stable) public CfnJobProps.Builder notificationProperty(CfnJob.NotificationPropertyProperty notificationProperty)
CfnJobProps.getNotificationProperty()
notificationProperty
- Specifies configuration properties of a notification.this
@Stability(value=Stable) public CfnJobProps.Builder numberOfWorkers(Number numberOfWorkers)
CfnJobProps.getNumberOfWorkers()
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
.this
@Stability(value=Stable) public CfnJobProps.Builder securityConfiguration(String securityConfiguration)
CfnJobProps.getSecurityConfiguration()
securityConfiguration
- The name of the `SecurityConfiguration` structure to be used with this job.this
@Stability(value=Stable) public CfnJobProps.Builder tags(Object tags)
CfnJobProps.getTags()
tags
- The tags to use with this job.this
@Stability(value=Stable) public CfnJobProps.Builder timeout(Number timeout)
CfnJobProps.getTimeout()
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).this
@Stability(value=Stable) public CfnJobProps.Builder workerType(String workerType)
CfnJobProps.getWorkerType()
workerType
- The type of predefined worker that is allocated when a job runs.
Accepts a value of Standard, G.1X, or G.2X.
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.this
@Stability(value=Stable) public CfnJobProps build()
build
in interface software.amazon.jsii.Builder<CfnJobProps>
CfnJobProps
NullPointerException
- if any required attribute was not providedCopyright © 2023. All rights reserved.