interface PySparkStreamingJobProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Glue.Alpha.PySparkStreamingJobProps |
![]() | github.com/aws/aws-cdk-go/awscdkgluealpha/v2#PySparkStreamingJobProps |
![]() | software.amazon.awscdk.services.glue.alpha.PySparkStreamingJobProps |
![]() | aws_cdk.aws_glue_alpha.PySparkStreamingJobProps |
![]() | @aws-cdk/aws-glue-alpha ยป PySparkStreamingJobProps |
Properties for creating a Python Spark ETL job.
Example
import * as cdk from 'aws-cdk-lib';
import * as iam from 'aws-cdk-lib/aws-iam';
declare const stack: cdk.Stack;
declare const role: iam.IRole;
declare const script: glue.Code;
new glue.PySparkStreamingJob(stack, 'ImportedJob', { role, script });
Properties
Name | Type | Description |
---|---|---|
role | IRole | 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. |
script | Code | Script Code Location (required) Script to run when the Glue job executes. |
connections? | IConnection [] | 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. |
continuous | Continuous | Enables continuous logging with the specified props. |
default | { [string]: string } | Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs. |
description? | string | Description (optional) Developer-specified description of the Glue job. |
enable | boolean | Enables the collection of metrics for job profiling. |
extra | Code [] | Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it. |
extra | Code [] | Extra Python Files S3 URL (optional) S3 URL where additional python dependencies are located. |
glue | Glue | Glue Version The version of Glue to use to execute this job. |
job | string | Name of the Glue job (optional) Developer-specified name of the Glue job. |
job | boolean | Specifies whether job run queuing is enabled for the job runs for this job. |
max | number | Max Concurrent Runs (optional) The maximum number of runs this Glue job can concurrently run. |
max | number | Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails. |
number | number | Number of Workers (optional) Number of workers for Glue to use during job execution. |
security | ISecurity | Security Configuration (optional) Defines the encryption options for the Glue job. |
spark | Spark | Enables the Spark UI debugging and monitoring with the specified props. |
tags? | { [string]: string } | Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources. |
timeout? | Duration | Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. |
worker | Worker | Worker Type (optional) Type of Worker for Glue to use during job execution Enum options: Standard, G_1X, G_2X, G_025X. |
role
Type:
IRole
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.
See also: https://docs.aws.amazon.com/glue/latest/dg/getting-started-access.html
script
Type:
Code
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
connections?
Type:
IConnection
[]
(optional, default: [] - no connections are added to the job)
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.
continuousLogging?
Type:
Continuous
(optional, default: continuous logging is enabled.)
Enables continuous logging with the specified props.
defaultArguments?
Type:
{ [string]: string }
(optional, default: no arguments)
Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs.
See also: [https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html for a list of reserved parameters](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html for a list of reserved parameters)
description?
Type:
string
(optional, default: no value)
Description (optional) Developer-specified description of the Glue job.
enableProfilingMetrics?
Type:
boolean
(optional, default: no profiling metrics emitted.)
Enables the collection of metrics for job profiling.
extraFiles?
Type:
Code
[]
(optional, default: no extra files specified.)
Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.
extraPythonFiles?
Type:
Code
[]
(optional, default: no extra files)
Extra Python Files S3 URL (optional) S3 URL where additional python dependencies are located.
glueVersion?
Type:
Glue
(optional, default: 3.0 for ETL)
Glue Version The version of Glue to use to execute this job.
jobName?
Type:
string
(optional, default: a name is automatically generated)
Name of the Glue job (optional) Developer-specified name of the Glue job.
jobRunQueuingEnabled?
Type:
boolean
(optional, default: no job run queuing)
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.
maxConcurrentRuns?
Type:
number
(optional, default: 1)
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.
maxRetries?
Type:
number
(optional, default: 0)
Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails.
numberOfWorkers?
Type:
number
(optional, default: 10)
Number of Workers (optional) Number of workers for Glue to use during job execution.
securityConfiguration?
Type:
ISecurity
(optional, default: no security configuration.)
Security Configuration (optional) Defines the encryption options for the Glue job.
sparkUI?
Type:
Spark
(optional, default: Spark UI debugging and monitoring is disabled.)
Enables the Spark UI debugging and monitoring with the specified props.
tags?
Type:
{ [string]: string }
(optional, default: {} - no tags)
Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources.
timeout?
Type:
Duration
(optional, default: 2880 (2 days for non-streaming))
Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
Specified in minutes.
workerType?
Type:
Worker
(optional, default: WorkerType.G_1X)
Worker Type (optional) Type of Worker for Glue to use during job execution Enum options: Standard, G_1X, G_2X, G_025X.
G_4X, G_8X, Z_2X