aws-cdk-lib.aws_sagemaker.CfnMonitoringSchedule.MonitoringScheduleConfigProperty

interface MonitoringScheduleConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnMonitoringSchedule.MonitoringScheduleConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnMonitoringSchedule_MonitoringScheduleConfigProperty
Javasoftware.amazon.awscdk.services.sagemaker.CfnMonitoringSchedule.MonitoringScheduleConfigProperty
Pythonaws_cdk.aws_sagemaker.CfnMonitoringSchedule.MonitoringScheduleConfigProperty
TypeScript aws-cdk-lib » aws_sagemaker » CfnMonitoringSchedule » MonitoringScheduleConfigProperty

Configures the monitoring schedule and 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 monitoringScheduleConfigProperty: sagemaker.CfnMonitoringSchedule.MonitoringScheduleConfigProperty = {
  monitoringJobDefinition: {
    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,
    },
  },
  monitoringJobDefinitionName: 'monitoringJobDefinitionName',
  monitoringType: 'monitoringType',
  scheduleConfig: {
    scheduleExpression: 'scheduleExpression',
  },
};

Properties

NameTypeDescription
monitoringJobDefinition?IResolvable | MonitoringJobDefinitionPropertyDefines the monitoring job.
monitoringJobDefinitionName?stringThe name of the monitoring job definition to schedule.
monitoringType?stringThe type of the monitoring job definition to schedule.
scheduleConfig?IResolvable | ScheduleConfigPropertyConfigures the monitoring schedule.

monitoringJobDefinition?

Type: IResolvable | MonitoringJobDefinitionProperty (optional)

Defines the monitoring job.


monitoringJobDefinitionName?

Type: string (optional)

The name of the monitoring job definition to schedule.


monitoringType?

Type: string (optional)

The type of the monitoring job definition to schedule.


scheduleConfig?

Type: IResolvable | ScheduleConfigProperty (optional)

Configures the monitoring schedule.