Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnMonitoringSchedulePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnMonitoringSchedulePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.119Z")
@Stability(Stable)
public class CfnMonitoringSchedulePropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::SageMaker::MonitoringSchedule resource is an Amazon SageMaker resource type that regularly starts SageMaker processing Jobs to monitor the data captured for a SageMaker endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnMonitoringSchedulePropsMixin cfnMonitoringSchedulePropsMixin = CfnMonitoringSchedulePropsMixin.Builder.create(CfnMonitoringScheduleMixinProps.builder()
         .endpointName("endpointName")
         .failureReason("failureReason")
         .lastMonitoringExecutionSummary(MonitoringExecutionSummaryProperty.builder()
                 .creationTime("creationTime")
                 .endpointName("endpointName")
                 .failureReason("failureReason")
                 .lastModifiedTime("lastModifiedTime")
                 .monitoringExecutionStatus("monitoringExecutionStatus")
                 .monitoringScheduleName("monitoringScheduleName")
                 .processingJobArn("processingJobArn")
                 .scheduledTime("scheduledTime")
                 .build())
         .monitoringScheduleConfig(MonitoringScheduleConfigProperty.builder()
                 .monitoringJobDefinition(MonitoringJobDefinitionProperty.builder()
                         .baselineConfig(BaselineConfigProperty.builder()
                                 .constraintsResource(ConstraintsResourceProperty.builder()
                                         .s3Uri("s3Uri")
                                         .build())
                                 .statisticsResource(StatisticsResourceProperty.builder()
                                         .s3Uri("s3Uri")
                                         .build())
                                 .build())
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .monitoringAppSpecification(MonitoringAppSpecificationProperty.builder()
                                 .containerArguments(List.of("containerArguments"))
                                 .containerEntrypoint(List.of("containerEntrypoint"))
                                 .imageUri("imageUri")
                                 .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
                                 .recordPreprocessorSourceUri("recordPreprocessorSourceUri")
                                 .build())
                         .monitoringInputs(List.of(MonitoringInputProperty.builder()
                                 .batchTransformInput(BatchTransformInputProperty.builder()
                                         .dataCapturedDestinationS3Uri("dataCapturedDestinationS3Uri")
                                         .datasetFormat(DatasetFormatProperty.builder()
                                                 .csv(CsvProperty.builder()
                                                         .header(false)
                                                         .build())
                                                 .json(JsonProperty.builder()
                                                         .line(false)
                                                         .build())
                                                 .parquet(false)
                                                 .build())
                                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                                         .localPath("localPath")
                                         .s3DataDistributionType("s3DataDistributionType")
                                         .s3InputMode("s3InputMode")
                                         .build())
                                 .endpointInput(EndpointInputProperty.builder()
                                         .endpointName("endpointName")
                                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                                         .localPath("localPath")
                                         .s3DataDistributionType("s3DataDistributionType")
                                         .s3InputMode("s3InputMode")
                                         .build())
                                 .build()))
                         .monitoringOutputConfig(MonitoringOutputConfigProperty.builder()
                                 .kmsKeyId("kmsKeyId")
                                 .monitoringOutputs(List.of(MonitoringOutputProperty.builder()
                                         .s3Output(S3OutputProperty.builder()
                                                 .localPath("localPath")
                                                 .s3UploadMode("s3UploadMode")
                                                 .s3Uri("s3Uri")
                                                 .build())
                                         .build()))
                                 .build())
                         .monitoringResources(MonitoringResourcesProperty.builder()
                                 .clusterConfig(ClusterConfigProperty.builder()
                                         .instanceCount(123)
                                         .instanceType("instanceType")
                                         .volumeKmsKeyId("volumeKmsKeyId")
                                         .volumeSizeInGb(123)
                                         .build())
                                 .build())
                         .networkConfig(NetworkConfigProperty.builder()
                                 .enableInterContainerTrafficEncryption(false)
                                 .enableNetworkIsolation(false)
                                 .vpcConfig(VpcConfigProperty.builder()
                                         .securityGroupIds(List.of("securityGroupIds"))
                                         .subnets(List.of("subnets"))
                                         .build())
                                 .build())
                         .roleArn("roleArn")
                         .stoppingCondition(StoppingConditionProperty.builder()
                                 .maxRuntimeInSeconds(123)
                                 .build())
                         .build())
                 .monitoringJobDefinitionName("monitoringJobDefinitionName")
                 .monitoringType("monitoringType")
                 .scheduleConfig(ScheduleConfigProperty.builder()
                         .dataAnalysisEndTime("dataAnalysisEndTime")
                         .dataAnalysisStartTime("dataAnalysisStartTime")
                         .scheduleExpression("scheduleExpression")
                         .build())
                 .build())
         .monitoringScheduleName("monitoringScheduleName")
         .monitoringScheduleStatus("monitoringScheduleStatus")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnMonitoringSchedulePropsMixin.BaselineConfigProperty	Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
static interface	CfnMonitoringSchedulePropsMixin.BatchTransformInputProperty	Input object for the batch transform job.
static final class	CfnMonitoringSchedulePropsMixin.Builder	A fluent builder for CfnMonitoringSchedulePropsMixin.
static interface	CfnMonitoringSchedulePropsMixin.ClusterConfigProperty	Configuration for the cluster used to run model monitoring jobs.
static interface	CfnMonitoringSchedulePropsMixin.ConstraintsResourceProperty	The Amazon S3 URI for the constraints resource.
static interface	CfnMonitoringSchedulePropsMixin.CsvProperty	The CSV format.
static interface	CfnMonitoringSchedulePropsMixin.DatasetFormatProperty	The dataset format of the data to monitor.
static interface	CfnMonitoringSchedulePropsMixin.EndpointInputProperty	Input object for the endpoint.
static interface	CfnMonitoringSchedulePropsMixin.JsonProperty	The Json format.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringAppSpecificationProperty	Container image configuration object for the monitoring job.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringExecutionSummaryProperty	Summary of information about the last monitoring job to run.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringInputProperty	The inputs for a monitoring job.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringJobDefinitionProperty	Defines the monitoring job.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringOutputConfigProperty	The output configuration for monitoring jobs.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringOutputProperty	The output object for a monitoring job.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringResourcesProperty	Identifies the resources to deploy for a monitoring job.
static interface	CfnMonitoringSchedulePropsMixin.MonitoringScheduleConfigProperty	Configures the monitoring schedule and defines the monitoring job.
static interface	CfnMonitoringSchedulePropsMixin.NetworkConfigProperty	Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
static interface	CfnMonitoringSchedulePropsMixin.S3OutputProperty	Information about where and how you want to store the results of a monitoring job.
static interface	CfnMonitoringSchedulePropsMixin.ScheduleConfigProperty	Configuration details about the monitoring schedule.
static interface	CfnMonitoringSchedulePropsMixin.StatisticsResourceProperty	The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
static interface	CfnMonitoringSchedulePropsMixin.StoppingConditionProperty	Specifies a limit to how long a job can run.
static interface	CfnMonitoringSchedulePropsMixin.VpcConfigProperty	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnMonitoringSchedulePropsMixin(CfnMonitoringScheduleMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::MonitoringSchedule.
	CfnMonitoringSchedulePropsMixin(CfnMonitoringScheduleMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::MonitoringSchedule.
protected	CfnMonitoringSchedulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMonitoringSchedulePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnMonitoringScheduleMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnMonitoringSchedulePropsMixin

protected CfnMonitoringSchedulePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnMonitoringSchedulePropsMixin

protected CfnMonitoringSchedulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMonitoringSchedulePropsMixin

@Stability(Stable)
public CfnMonitoringSchedulePropsMixin(@NotNull
 CfnMonitoringScheduleMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SageMaker::MonitoringSchedule.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnMonitoringSchedulePropsMixin

@Stability(Stable)
public CfnMonitoringSchedulePropsMixin(@NotNull
 CfnMonitoringScheduleMixinProps props)

Create a mixin to apply properties to AWS::SageMaker::MonitoringSchedule.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnMonitoringScheduleMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()