Package software.amazon.awscdk.services.glue

Class PythonShellJob.Builder

java.lang.Object
software.amazon.awscdk.services.glue.PythonShellJob.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<PythonShellJob>
Enclosing class:
PythonShellJob
@Stability(Stable) public static final class PythonShellJob.Builder extends Object implements software.amazon.jsii.Builder<PythonShellJob>
A fluent builder for PythonShellJob.

  • Method Details

    • create

      @Stability(Stable) public static PythonShellJob.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of PythonShellJob.Builder.

    • role

      @Stability(Stable) public PythonShellJob.Builder role(IRole role)
      IAM Role (required) IAM Role to use for Glue job execution Must be specified by the developer because the L2 doesn't have visibility into the actions the script(s) takes during the job execution The role must trust the Glue service principal (glue.amazonaws.com) and be granted sufficient permissions.

      Parameters:
      role - IAM Role (required) IAM Role to use for Glue job execution Must be specified by the developer because the L2 doesn't have visibility into the actions the script(s) takes during the job execution The role must trust the Glue service principal (glue.amazonaws.com) and be granted sufficient permissions. This parameter is required.
      Returns:
      this
      See Also:

    • script

      @Stability(Stable) public PythonShellJob.Builder script(Code script)
      Script Code Location (required) Script to run when the Glue job executes.

      Can be uploaded from the local directory structure using fromAsset or referenced via S3 location using fromBucket

      Parameters:
      script - Script Code Location (required) Script to run when the Glue job executes. This parameter is required.
      Returns:
      this

    • connections

      @Stability(Stable) public PythonShellJob.Builder connections(List<? extends IConnection> connections)
      Connections (optional) List of connections to use for this Glue job Connections are used to connect to other AWS Service or resources within a VPC.

      Default: [] - no connections are added to the job

      Parameters:
      connections - Connections (optional) List of connections to use for this Glue job Connections are used to connect to other AWS Service or resources within a VPC. This parameter is required.
      Returns:
      this

    • continuousLogging

      @Stability(Stable) public PythonShellJob.Builder continuousLogging(ContinuousLoggingProps continuousLogging)
      Enables continuous logging with the specified props.

      Default: - continuous logging is enabled.

      Parameters:
      continuousLogging - Enables continuous logging with the specified props. This parameter is required.
      Returns:
      this
      See Also:

    • defaultArguments

      @Stability(Stable) public PythonShellJob.Builder defaultArguments(Map<String,String> defaultArguments)
      Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs.

      This map is the escape hatch for Glue job arguments that this construct does not model. It MUST NOT be used to set arguments that already have a dedicated prop — configure those through the corresponding prop instead (continuousLogging, enableMetrics, enableObservabilityMetrics, sparkUI, className, extraJars, extraJarsFirst, extraPythonFiles, extraFiles). Passing a construct-managed argument (e.g. --enable-continuous-cloudwatch-log, --enable-metrics, --enable-spark-ui, --job-language) or a Glue-reserved argument (--debug, --mode, --JOB_NAME, --endpoint) here throws at synthesis time, so there is exactly one way to express each intent.

      Also note that these are emitted verbatim into the CloudFormation template, so avoid placing secrets here in plaintext. Pass secrets to the job at runtime through AWS Secrets Manager instead. A synthesis-time warning is emitted when an argument key looks like a credential and holds a plaintext literal.

      Default: - no arguments

      Parameters:
      defaultArguments - Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs. This parameter is required.
      Returns:
      this
      See Also:

    • description

      @Stability(Stable) public PythonShellJob.Builder description(String description)
      Description (optional) Developer-specified description of the Glue job.

      Default: - no value

      Parameters:
      description - Description (optional) Developer-specified description of the Glue job. This parameter is required.
      Returns:
      this

    • glueVersion

      @Stability(Stable) public PythonShellJob.Builder glueVersion(GlueVersion glueVersion)
      Glue Version The version of Glue to use to execute this job.

      Default: - determined by the job type: 4.0 for ETL and Streaming, 5.0 for Flex, 3.0 for Python Shell

      Parameters:
      glueVersion - Glue Version The version of Glue to use to execute this job. This parameter is required.
      Returns:
      this

    • jobName

      @Stability(Stable) public PythonShellJob.Builder jobName(String jobName)
      Name of the Glue job (optional) Developer-specified name of the Glue job.

      Default: - a name is automatically generated

      Parameters:
      jobName - Name of the Glue job (optional) Developer-specified name of the Glue job. This parameter is required.
      Returns:
      this

    • maxConcurrentRuns

      @Stability(Stable) public PythonShellJob.Builder maxConcurrentRuns(Number maxConcurrentRuns)
      Max Concurrent Runs (optional) The maximum number of runs this Glue job can concurrently run.

      An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

      Default: 1

      Parameters:
      maxConcurrentRuns - Max Concurrent Runs (optional) The maximum number of runs this Glue job can concurrently run. This parameter is required.
      Returns:
      this

    • maxRetries

      @Stability(Stable) public PythonShellJob.Builder maxRetries(Number maxRetries)
      Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails.

      Default: 0

      Parameters:
      maxRetries - Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails. This parameter is required.
      Returns:
      this

    • securityConfiguration

      @Stability(Stable) public PythonShellJob.Builder securityConfiguration(ISecurityConfiguration securityConfiguration)
      Security Configuration (optional) Defines the encryption options for the Glue job.

      Default: - no security configuration.

      Parameters:
      securityConfiguration - Security Configuration (optional) Defines the encryption options for the Glue job. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public PythonShellJob.Builder tags(Map<String,String> tags)
      Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources.

      Default: {} - no tags

      Parameters:
      tags - Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Stable) public PythonShellJob.Builder timeout(Duration timeout)
      Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.

      Specified in minutes.

      Default: - no value set; Glue applies its service default (2880 minutes for non-streaming jobs)

      Parameters:
      timeout - Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This parameter is required.
      Returns:
      this

    • extraPythonFiles

      @Stability(Stable) public PythonShellJob.Builder extraPythonFiles(List<? extends Code> extraPythonFiles)
      Additional Python files that AWS Glue adds to the Python path before executing your script.

      Only individual files are supported, directories are not supported. Equivalent to the --extra-py-files job argument.

      Default: - no extra Python files

      Parameters:
      extraPythonFiles - Additional Python files that AWS Glue adds to the Python path before executing your script. This parameter is required.
      Returns:
      this
      See Also:

    • jobRunQueuingEnabled

      @Stability(Stable) public PythonShellJob.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. This property must be set to false for flex jobs. If this property is enabled, maxRetries must be set to zero.

      Default: false

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

    • librarySet

      @Stability(Stable) public PythonShellJob.Builder librarySet(LibrarySet librarySet)
      The set of pre-installed Python libraries to make available to the job.

      Only applies to jobs running Python 3.9. Set to LibrarySet.NONE when your libraries are custom or conflict with the pre-installed ones.

      Default: LibrarySet.ANALYTICS when running Python 3.9, otherwise no library set is configured

      Parameters:
      librarySet - The set of pre-installed Python libraries to make available to the job. This parameter is required.
      Returns:
      this
      See Also:

    • maxCapacity

      @Stability(Stable) public PythonShellJob.Builder maxCapacity(MaxCapacity maxCapacity)
      The total number of DPU to assign to the Python Job.

      Default: 0.0625

      Parameters:
      maxCapacity - The total number of DPU to assign to the Python Job. This parameter is required.
      Returns:
      this

    • pythonVersion

      @Stability(Stable) public PythonShellJob.Builder pythonVersion(PythonVersion pythonVersion)
      The version of Python to use to execute this job.

      Python shell jobs only support PythonVersion.THREE_NINE. The older PythonVersion.TWO (Python 2.7) and PythonVersion.THREE (Python 3.6) runtimes have been retired by AWS Glue and are no longer available for Python shell jobs.

      Default: PythonVersion.THREE_NINE

      Parameters:
      pythonVersion - The version of Python to use to execute this job. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public PythonShellJob build()
      Specified by:
      build in interface software.amazon.jsii.Builder<PythonShellJob>
      Returns:
      a newly built instance of PythonShellJob.