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

Interface CfnMonitoringScheduleMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMonitoringScheduleMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.118Z")
@Stability(Stable)
public interface CfnMonitoringScheduleMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnMonitoringSchedulePropsMixin.

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.*;
 CfnMonitoringScheduleMixinProps cfnMonitoringScheduleMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMonitoringScheduleMixinProps.Builder	builder()
default String	getEndpointName()	The name of the endpoint using the monitoring schedule.
default String	getFailureReason()	Contains the reason a monitoring job failed, if it failed.
default Object	getLastMonitoringExecutionSummary()	Describes metadata on the last execution to run, if there was one.
default Object	getMonitoringScheduleConfig()	The configuration object that specifies the monitoring schedule and defines the monitoring job.
default String	getMonitoringScheduleName()	The name of the monitoring schedule.
default String	getMonitoringScheduleStatus()	The status of the monitoring schedule.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointName

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

The name of the endpoint using the monitoring schedule.

See Also:

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

getFailureReason

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

Contains the reason a monitoring job failed, if it failed.

See Also:

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

getLastMonitoringExecutionSummary

@Stability(Stable)
@Nullable
default Object getLastMonitoringExecutionSummary()

Describes metadata on the last execution to run, if there was one.

Returns union: either IResolvable or CfnMonitoringSchedulePropsMixin.MonitoringExecutionSummaryProperty

See Also:

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

getMonitoringScheduleConfig

@Stability(Stable)
@Nullable
default Object getMonitoringScheduleConfig()

The configuration object that specifies the monitoring schedule and defines the monitoring job.

Returns union: either IResolvable or CfnMonitoringSchedulePropsMixin.MonitoringScheduleConfigProperty

See Also:

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

getMonitoringScheduleName

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

The name of the monitoring schedule.

See Also:

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

getMonitoringScheduleStatus

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

The status of the monitoring schedule.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

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

builder

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

Returns:

a CfnMonitoringScheduleMixinProps.Builder of CfnMonitoringScheduleMixinProps