aws-cdk-lib.aws_sagemaker.CfnMonitoringScheduleProps

interface CfnMonitoringScheduleProps

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

Properties for defining a CfnMonitoringSchedule.

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 cfnMonitoringScheduleProps: sagemaker.CfnMonitoringScheduleProps = {
  monitoringScheduleConfig: {
    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',
    },
  },
  monitoringScheduleName: 'monitoringScheduleName',

  // the properties below are optional
  endpointName: 'endpointName',
  failureReason: 'failureReason',
  lastMonitoringExecutionSummary: {
    creationTime: 'creationTime',
    lastModifiedTime: 'lastModifiedTime',
    monitoringExecutionStatus: 'monitoringExecutionStatus',
    monitoringScheduleName: 'monitoringScheduleName',
    scheduledTime: 'scheduledTime',

    // the properties below are optional
    endpointName: 'endpointName',
    failureReason: 'failureReason',
    processingJobArn: 'processingJobArn',
  },
  monitoringScheduleStatus: 'monitoringScheduleStatus',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
monitoringScheduleConfigIResolvable | MonitoringScheduleConfigPropertyThe configuration object that specifies the monitoring schedule and defines the monitoring job.
monitoringScheduleNamestringThe name of the monitoring schedule.
endpointName?stringThe name of the endpoint using the monitoring schedule.
failureReason?stringContains the reason a monitoring job failed, if it failed.
lastMonitoringExecutionSummary?IResolvable | MonitoringExecutionSummaryPropertyDescribes metadata on the last execution to run, if there was one.
monitoringScheduleStatus?stringThe status of the monitoring schedule.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

monitoringScheduleConfig

Type: IResolvable | MonitoringScheduleConfigProperty

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


monitoringScheduleName

Type: string

The name of the monitoring schedule.


endpointName?

Type: string (optional)

The name of the endpoint using the monitoring schedule.


failureReason?

Type: string (optional)

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


lastMonitoringExecutionSummary?

Type: IResolvable | MonitoringExecutionSummaryProperty (optional)

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


monitoringScheduleStatus?

Type: string (optional)

The status of the monitoring schedule.


tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .