software.amazon.awscdk.services.sagemaker

Interface CfnMonitoringSchedule.MonitoringJobDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMonitoringSchedule.MonitoringJobDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnMonitoringSchedule

@Stability(value=Stable)
public static interface CfnMonitoringSchedule.MonitoringJobDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

Defines the monitoring job.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 MonitoringJobDefinitionProperty monitoringJobDefinitionProperty = MonitoringJobDefinitionProperty.builder()
         .monitoringAppSpecification(MonitoringAppSpecificationProperty.builder()
                 .imageUri("imageUri")
                 // the properties below are optional
                 .containerArguments(List.of("containerArguments"))
                 .containerEntrypoint(List.of("containerEntrypoint"))
                 .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
                 .recordPreprocessorSourceUri("recordPreprocessorSourceUri")
                 .build())
         .monitoringInputs(List.of(MonitoringInputProperty.builder()
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .localPath("localPath")
                         // the properties below are optional
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .build()))
         .monitoringOutputConfig(MonitoringOutputConfigProperty.builder()
                 .monitoringOutputs(List.of(MonitoringOutputProperty.builder()
                         .s3Output(S3OutputProperty.builder()
                                 .localPath("localPath")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .s3UploadMode("s3UploadMode")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .monitoringResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeSizeInGb(123)
                         // the properties below are optional
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .build())
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .baselineConfig(BaselineConfigProperty.builder()
                 .constraintsResource(ConstraintsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .statisticsResource(StatisticsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         .environment(Map.of(
                 "environmentKey", "environment"))
         .networkConfig(NetworkConfigProperty.builder()
                 .enableInterContainerTrafficEncryption(false)
                 .enableNetworkIsolation(false)
                 .vpcConfig(VpcConfigProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnets(List.of("subnets"))
                         .build())
                 .build())
         .stoppingCondition(StoppingConditionProperty.builder()
                 .maxRuntimeInSeconds(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnMonitoringSchedule.MonitoringJobDefinitionProperty.Builder	builder()
default Object	getBaselineConfig() Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
default Object	getEnvironment() Sets the environment variables in the Docker container.
Object	getMonitoringAppSpecification() Configures the monitoring job to run a specified Docker container image.
Object	getMonitoringInputs() The array of inputs for the monitoring job.
Object	getMonitoringOutputConfig() The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
Object	getMonitoringResources() Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
default Object	getNetworkConfig() Specifies networking options for an monitoring job.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
default Object	getStoppingCondition() Specifies a time limit for how long the monitoring job is allowed to run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMonitoringAppSpecification

@Stability(value=Stable)
 @NotNull
Object getMonitoringAppSpecification()

Configures the monitoring job to run a specified Docker container image.

getMonitoringInputs

@Stability(value=Stable)
 @NotNull
Object getMonitoringInputs()

The array of inputs for the monitoring job.

Currently we support monitoring an Amazon SageMaker Endpoint.

getMonitoringOutputConfig

@Stability(value=Stable)
 @NotNull
Object getMonitoringOutputConfig()

The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).

getMonitoringResources

@Stability(value=Stable)
 @NotNull
Object getMonitoringResources()

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.

In distributed processing, you specify more than one instance.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

getBaselineConfig

@Stability(value=Stable)
 @Nullable
default Object getBaselineConfig()

Baseline configuration used to validate that the data conforms to the specified constraints and statistics.

getEnvironment

@Stability(value=Stable)
 @Nullable
default Object getEnvironment()

Sets the environment variables in the Docker container.

getNetworkConfig

@Stability(value=Stable)
 @Nullable
default Object getNetworkConfig()

Specifies networking options for an monitoring job.

getStoppingCondition

@Stability(value=Stable)
 @Nullable
default Object getStoppingCondition()

Specifies a time limit for how long the monitoring job is allowed to run.

builder

@Stability(value=Stable)
static CfnMonitoringSchedule.MonitoringJobDefinitionProperty.Builder builder()

Returns:

a CfnMonitoringSchedule.MonitoringJobDefinitionProperty.Builder of CfnMonitoringSchedule.MonitoringJobDefinitionProperty