ScalaSparkEtlJobProps Struct
Properties for creating a Scala Spark ETL job.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_glue as glue } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_logs as logs } from 'aws-cdk-lib';
import { aws_s3 as s3 } from 'aws-cdk-lib';
declare const bucket: s3.Bucket;
declare const code: glue.Code;
declare const connection: glue.Connection;
declare const logGroup: logs.LogGroup;
declare const role: iam.Role;
declare const securityConfiguration: glue.SecurityConfiguration;
const scalaSparkEtlJobProps: glue.ScalaSparkEtlJobProps = {
className: 'className',
role: role,
script: code,
// the properties below are optional
connections: [connection],
continuousLogging: {
enabled: false,
// the properties below are optional
conversionPattern: 'conversionPattern',
logGroup: logGroup,
logStreamPrefix: 'logStreamPrefix',
quiet: false,
},
defaultArguments: {
defaultArgumentsKey: 'defaultArguments',
},
description: 'description',
enableMetrics: false,
enableObservabilityMetrics: false,
extraFiles: [code],
extraJars: [code],
extraJarsFirst: false,
glueVersion: glue.GlueVersion.V0_9,
jobName: 'jobName',
jobRunQueuingEnabled: false,
maxConcurrentRuns: 123,
maxRetries: 123,
notifyDelayAfter: cdk.Duration.minutes(30),
securityConfiguration: securityConfiguration,
sparkUI: {
bucket: bucket,
prefix: 'prefix',
},
tags: {
tagsKey: 'tags',
},
timeout: cdk.Duration.minutes(30),
workerConfiguration: {
numberOfWorkers: 123,
workerType: glue.WorkerType.STANDARD,
},
};
Properties
connectionsoptionalIConnection[]connectionsoptionaltyping.List[IConnection]connectionsoptionalList<IConnection>ConnectionsoptionalIConnection[]Connectionsoptional*[]IConnection#Default: [] - no connections are added to the job
continuousLoggingoptionalContinuousLoggingPropscontinuous_loggingoptionalContinuousLoggingPropscontinuousLoggingoptionalContinuousLoggingPropsContinuousLoggingoptionalContinuousLoggingPropsContinuousLoggingoptionalContinuousLoggingProps#Default: continuous logging is enabled.
defaultArgumentsoptional{ [key: string]: string }default_argumentsoptionaltyping.Mapping[str, str]defaultArgumentsoptionalMap<String, String>DefaultArgumentsoptionalIDictionary<string, string>DefaultArgumentsoptional*map[string]*string#Default: no arguments
notes
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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: no value
enableMetricsoptionalbooleanenable_metricsoptionalboolenableMetricsoptionalBooleanEnableMetricsoptionalboolEnableMetricsoptional*bool= true#When enabled, adds '--enable-metrics' to job arguments.
enableObservabilityMetricsoptionalbooleanenable_observability_metricsoptionalboolenableObservabilityMetricsoptionalBooleanEnableObservabilityMetricsoptionalboolEnableObservabilityMetricsoptional*bool= true#When enabled, adds '--enable-observability-metrics': 'true' to job arguments.
extraFilesoptionalCode[]extra_filesoptionaltyping.List[Code]extraFilesoptionalList<Code>ExtraFilesoptionalCode[]ExtraFilesoptional*[]Code#Default: no extra files specified.
extraJarsoptionalCode[]extra_jarsoptionaltyping.List[Code]extraJarsoptionalList<Code>ExtraJarsoptionalCode[]ExtraJarsoptional*[]Code#Default: no extra jar files
extraJarsFirstoptionalbooleanextra_jars_firstoptionalboolextraJarsFirstoptionalBooleanExtraJarsFirstoptionalboolExtraJarsFirstoptional*bool#Default: false - priority is not given to user-provided jars
glueVersionoptionalGlueVersionglue_versionoptionalGlueVersionglueVersionoptionalGlueVersionGlueVersionoptionalGlueVersionGlueVersionoptionalGlueVersion#Default: determined by the job type: 4.0 for ETL and Streaming, 5.0 for Flex, 3.0 for Python Shell
jobNameoptionalstringjob_nameoptionalstrjobNameoptionalStringJobNameoptionalstringJobNameoptional*string#Default: a name is automatically generated
jobRunQueuingEnabledoptionalbooleanjob_run_queuing_enabledoptionalbooljobRunQueuingEnabledoptionalBooleanJobRunQueuingEnabledoptionalboolJobRunQueuingEnabledoptional*bool#Default: no job run queuing
notes
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.
maxConcurrentRunsoptionalnumbermax_concurrent_runsoptionalint | floatmaxConcurrentRunsoptionalNumberMaxConcurrentRunsoptionaldoubleMaxConcurrentRunsoptional*float64= 1#An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
maxRetriesoptionalnumbermax_retriesoptionalint | floatmaxRetriesoptionalNumberMaxRetriesoptionaldoubleMaxRetriesoptional*float64= 0#notifyDelayAfteroptionalDurationnotify_delay_afteroptionalDurationnotifyDelayAfteroptionalDurationNotifyDelayAfteroptionalDurationNotifyDelayAfteroptionalDuration= undefined#After a job run starts, the number of minutes to wait before sending a job run delay notification.
Can be uploaded from the local directory structure using fromAsset or referenced via S3 location using fromBucket
securityConfigurationoptionalISecurityConfigurationsecurity_configurationoptionalISecurityConfigurationsecurityConfigurationoptionalISecurityConfigurationSecurityConfigurationoptionalISecurityConfigurationSecurityConfigurationoptionalISecurityConfiguration#Default: no security configuration.
sparkUIoptionalSparkUIPropsspark_uioptionalSparkUIPropssparkUIoptionalSparkUIPropsSparkUIoptionalSparkUIPropsSparkUIoptionalSparkUIProps#Default: Spark UI debugging and monitoring is disabled.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Default: {} - no tags
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration#Default: no value set; Glue applies its service default (2880 minutes for non-streaming jobs)
Specified in minutes.
workerConfigurationoptionalWorkerConfigurationworker_configurationoptionalWorkerConfigurationworkerConfigurationoptionalWorkerConfigurationWorkerConfigurationoptionalWorkerConfigurationWorkerConfigurationoptionalWorkerConfiguration#Default: the job runs with the G_1X worker type and 10 workers.