Show / Hide Table of Contents

Interface ISparkJobProps

(experimental) Common properties for different types of Spark jobs.

Inherited Members
IJobProps.Role
IJobProps.Script
IJobProps.Connections
IJobProps.ContinuousLogging
IJobProps.DefaultArguments
IJobProps.Description
IJobProps.EnableProfilingMetrics
IJobProps.GlueVersion
IJobProps.JobName
IJobProps.MaxConcurrentRuns
IJobProps.MaxRetries
IJobProps.NumberOfWorkers
IJobProps.SecurityConfiguration
IJobProps.Tags
IJobProps.Timeout
IJobProps.WorkerType
Namespace: Amazon.CDK.AWS.Glue.Alpha
Assembly: Amazon.CDK.AWS.Glue.Alpha.dll
Syntax (csharp)
public interface ISparkJobProps : IJobProps
Syntax (vb)
Public Interface ISparkJobProps Inherits IJobProps
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue.Alpha;
             using Amazon.CDK;
             using Amazon.CDK.AWS.IAM;
             using Amazon.CDK.AWS.Logs;
             using Amazon.CDK.AWS.S3;

             Bucket bucket;
             Code code;
             Connection connection;
             LogGroup logGroup;
             Role role;
             SecurityConfiguration securityConfiguration;

             var sparkJobProps = new SparkJobProps {
                 Role = role,
                 Script = code,

                 // the properties below are optional
                 Connections = new [] { connection },
                 ContinuousLogging = new ContinuousLoggingProps {
                     Enabled = false,

                     // the properties below are optional
                     ConversionPattern = "conversionPattern",
                     LogGroup = logGroup,
                     LogStreamPrefix = "logStreamPrefix",
                     Quiet = false
                 },
                 DefaultArguments = new Dictionary<string, string> {
                     { "defaultArgumentsKey", "defaultArguments" }
                 },
                 Description = "description",
                 EnableMetrics = false,
                 EnableObservabilityMetrics = false,
                 EnableProfilingMetrics = false,
                 GlueVersion = GlueVersion.V0_9,
                 JobName = "jobName",
                 MaxConcurrentRuns = 123,
                 MaxRetries = 123,
                 NumberOfWorkers = 123,
                 SecurityConfiguration = securityConfiguration,
                 SparkUI = new SparkUIProps {
                     Bucket = bucket,
                     Prefix = "prefix"
                 },
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Timeout = Duration.Minutes(30),
                 WorkerType = WorkerType.STANDARD
             };

Synopsis

Properties

EnableMetrics

(experimental) Enable profiling metrics for the Glue job.

EnableObservabilityMetrics

(experimental) Enable observability metrics for the Glue job.

SparkUI

(experimental) Enables the Spark UI debugging and monitoring with the specified props.

Properties

EnableMetrics

(experimental) Enable profiling metrics for the Glue job.

bool? EnableMetrics { get; }
Property Value

bool?

Remarks

When enabled, adds '--enable-metrics' to job arguments.

Default: true

Stability: Experimental

EnableObservabilityMetrics

(experimental) Enable observability metrics for the Glue job.

bool? EnableObservabilityMetrics { get; }
Property Value

bool?

Remarks

When enabled, adds '--enable-observability-metrics': 'true' to job arguments.

Default: true

Stability: Experimental

SparkUI

(experimental) Enables the Spark UI debugging and monitoring with the specified props.

ISparkUIProps? SparkUI { get; }
Property Value

ISparkUIProps

Remarks

Default: - Spark UI debugging and monitoring is disabled.

Stability: Experimental

See: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

Back to top Generated by DocFX