Package software.amazon.awscdk.services.stepfunctions.tasks

Interface Monitoring

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Monitoring.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:18.966Z")
@Stability(Stable)
public interface Monitoring
extends software.amazon.jsii.JsiiSerializable

Configuration setting for monitoring.

Example:

 EmrContainersStartJobRun.Builder.create(this, "EMR Containers Start Job Run")
         .virtualCluster(VirtualClusterInput.fromVirtualClusterId("de92jdei2910fwedz"))
         .releaseLabel(ReleaseLabel.EMR_6_2_0)
         .jobDriver(JobDriver.builder()
                 .sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
                         .entryPoint(TaskInput.fromText("local:///usr/lib/spark/examples/src/main/python/pi.py"))
                         .sparkSubmitParameters("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1")
                         .build())
                 .build())
         .monitoring(Monitoring.builder()
                 .logging(true)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Monitoring.Builder	A builder for Monitoring
static final class	Monitoring.Jsii$Proxy	An implementation for Monitoring

Method Summary

Modifier and Type	Method	Description
static Monitoring.Builder	builder()
default IBucket	getLogBucket()	Amazon S3 Bucket for monitoring log publishing.
default Boolean	getLogging()	Enable logging for this job.
default ILogGroup	getLogGroup()	A log group for CloudWatch monitoring.
default String	getLogStreamNamePrefix()	A log stream name prefix for Cloudwatch monitoring.
default Boolean	getPersistentAppUI()	Monitoring configurations for the persistent application UI.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogBucket

@Stability(Stable)
@Nullable
default IBucket getLogBucket()

Amazon S3 Bucket for monitoring log publishing.

You can configure your jobs to send log information to Amazon S3.

Default: - if `logging` is manually set to `true` and a `logBucket` is not provided, a `logBucket` will be automatically generated`.

getLogging

@Stability(Stable)
@Nullable
default Boolean getLogging()

Enable logging for this job.

If set to true, will automatically create a Cloudwatch Log Group and S3 bucket. This will be set to true implicitly if values are provided for logGroup or logBucket.

Default: true - true if values are provided for `logGroup` or `logBucket`, false otherwise

getLogGroup

@Stability(Stable)
@Nullable
default ILogGroup getLogGroup()

A log group for CloudWatch monitoring.

You can configure your jobs to send log information to CloudWatch Logs.

Default: - if `logging` is manually set to `true` and a `logGroup` is not provided, a `logGroup` will be automatically generated`.

getLogStreamNamePrefix

@Stability(Stable)
@Nullable
default String getLogStreamNamePrefix()

A log stream name prefix for Cloudwatch monitoring.

Default: - Log streams created in this log group have no default prefix

getPersistentAppUI

@Stability(Stable)
@Nullable
default Boolean getPersistentAppUI()

Monitoring configurations for the persistent application UI.

Default: true

builder

@Stability(Stable)
static Monitoring.Builder builder()

Returns:

a Monitoring.Builder of Monitoring