aws-cdk-lib.aws_sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty

interface MonitoringJobDefinitionProperty

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnMonitoringSchedule_MonitoringJobDefinitionProperty
Javasoftware.amazon.awscdk.services.sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty
Pythonaws_cdk.aws_sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty
TypeScript aws-cdk-lib » 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 { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
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: {
          line: false,
        },
        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

NameTypeDescription
monitoringAppSpecificationIResolvable | MonitoringAppSpecificationPropertyConfigures the monitoring job to run a specified Docker container image.
monitoringInputsIResolvable | IResolvable | MonitoringInputProperty[]The array of inputs for the monitoring job.
monitoringOutputConfigIResolvable | MonitoringOutputConfigPropertyThe array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
monitoringResourcesIResolvable | MonitoringResourcesPropertyIdentifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job.
roleArnstringThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
baselineConfig?IResolvable | BaselineConfigPropertyBaseline 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 | NetworkConfigPropertySpecifies networking options for an monitoring job.
stoppingCondition?IResolvable | StoppingConditionPropertySpecifies a time limit for how long the monitoring job is allowed to run.

monitoringAppSpecification

Type: IResolvable | MonitoringAppSpecificationProperty

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


monitoringInputs

Type: IResolvable | IResolvable | MonitoringInputProperty[]

The array of inputs for the monitoring job.

Currently we support monitoring an Amazon SageMaker Endpoint.


monitoringOutputConfig

Type: IResolvable | MonitoringOutputConfigProperty

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


monitoringResources

Type: IResolvable | MonitoringResourcesProperty

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.


roleArn

Type: string

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


baselineConfig?

Type: IResolvable | BaselineConfigProperty (optional)

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


environment?

Type: IResolvable | { [string]: string } (optional)

Sets the environment variables in the Docker container.


networkConfig?

Type: IResolvable | NetworkConfigProperty (optional)

Specifies networking options for an monitoring job.


stoppingCondition?

Type: IResolvable | StoppingConditionProperty (optional)

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