interface MonitoringJobDefinitionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty`
Python	`aws_cdk.aws_sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty`
TypeScript	`@aws-cdk/aws-sagemaker` » `CfnMonitoringSchedule` » `MonitoringJobDefinitionProperty`

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 * as sagemaker from '@aws-cdk/aws-sagemaker';

declare const json: any;
const monitoringJobDefinitionProperty: sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty = {
  monitoringAppSpecification: {
    imageUri: 'imageUri',

    // the properties below are optional
    containerArguments: ['containerArguments'],
    containerEntrypoint: ['containerEntrypoint'],
    postAnalyticsProcessorSourceUri: 'postAnalyticsProcessorSourceUri',
    recordPreprocessorSourceUri: 'recordPreprocessorSourceUri',
  },
  monitoringInputs: [{
    batchTransformInput: {
      dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
      datasetFormat: {
        csv: {
          header: false,
        },
        json: json,
        parquet: false,
      },
      localPath: 'localPath',

      // the properties below are optional
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
    },
    endpointInput: {
      endpointName: 'endpointName',
      localPath: 'localPath',

      // the properties below are optional
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
    },
  }],
  monitoringOutputConfig: {
    monitoringOutputs: [{
      s3Output: {
        localPath: 'localPath',
        s3Uri: 's3Uri',

        // the properties below are optional
        s3UploadMode: 's3UploadMode',
      },
    }],

    // the properties below are optional
    kmsKeyId: 'kmsKeyId',
  },
  monitoringResources: {
    clusterConfig: {
      instanceCount: 123,
      instanceType: 'instanceType',
      volumeSizeInGb: 123,

      // the properties below are optional
      volumeKmsKeyId: 'volumeKmsKeyId',
    },
  },
  roleArn: 'roleArn',

  // the properties below are optional
  baselineConfig: {
    constraintsResource: {
      s3Uri: 's3Uri',
    },
    statisticsResource: {
      s3Uri: 's3Uri',
    },
  },
  environment: {
    environmentKey: 'environment',
  },
  networkConfig: {
    enableInterContainerTrafficEncryption: false,
    enableNetworkIsolation: false,
    vpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
  },
  stoppingCondition: {
    maxRuntimeInSeconds: 123,
  },
};

Properties

Name	Type	Description
monitoringAppSpecification	`IResolvable` `\|` `MonitoringAppSpecificationProperty`	Configures the monitoring job to run a specified Docker container image.
monitoringInputs	`IResolvable` `\|` `IResolvable` `\|` `MonitoringInputProperty[]`	The array of inputs for the monitoring job.
monitoringOutputConfig	`IResolvable` `\|` `MonitoringOutputConfigProperty`	The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
monitoringResources	`IResolvable` `\|` `MonitoringResourcesProperty`	Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
roleArn	`string`	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
baselineConfig?	`IResolvable` `\|` `BaselineConfigProperty`	Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
environment?	`IResolvable` `\| { [string]: string }`	Sets the environment variables in the Docker container.
networkConfig?	`IResolvable` `\|` `NetworkConfigProperty`	Specifies networking options for an monitoring job.
stoppingCondition?	`IResolvable` `\|` `StoppingConditionProperty`	Specifies a time limit for how long the monitoring job is allowed to run.