Class: AWSCDK::Sagemaker::CfnMonitoringSchedule::ScheduleConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_monitoring_schedule.rb

Overview

Configuration details about the monitoring schedule.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schedule_expression:, data_analysis_end_time: nil, data_analysis_start_time: nil) ⇒ ScheduleConfigProperty

Returns a new instance of ScheduleConfigProperty.

Parameters:

  • schedule_expression (String) —

    A cron expression that describes details about the monitoring schedule.

  • data_analysis_end_time (String, nil) (defaults to: nil) —

    Sets the end time for a monitoring job window.

  • data_analysis_start_time (String, nil) (defaults to: nil) —

    Sets the start time for a monitoring job window.



1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 1667

def initialize(schedule_expression:, data_analysis_end_time: nil, data_analysis_start_time: nil)
  @schedule_expression = schedule_expression
  Jsii::Type.check_type(@schedule_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduleExpression")
  @data_analysis_end_time = data_analysis_end_time
  Jsii::Type.check_type(@data_analysis_end_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataAnalysisEndTime") unless @data_analysis_end_time.nil?
  @data_analysis_start_time = data_analysis_start_time
  Jsii::Type.check_type(@data_analysis_start_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataAnalysisStartTime") unless @data_analysis_start_time.nil?
end

Instance Attribute Details

#data_analysis_end_time ⇒ String? (readonly)

Sets the end time for a monitoring job window.

Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: "-PT1H" .

The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the DataAnalysisStartTime parameter.

If you set ScheduleExpression to NOW , this parameter is required.

Returns:

  • (String, nil)

See Also:



1724
1725
1726
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 1724

def data_analysis_end_time
  @data_analysis_end_time
end

#data_analysis_start_time ⇒ String? (readonly)

Sets the start time for a monitoring job window.

Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: "-PT5H" .

The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the DataAnalysisEndTime parameter.

If you set ScheduleExpression to NOW , this parameter is required.

Returns:

  • (String, nil)

See Also:



1735
1736
1737
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 1735

def data_analysis_start_time
  @data_analysis_start_time
end

#schedule_expression ⇒ String (readonly)

A cron expression that describes details about the monitoring schedule.

The supported cron expressions are:

  • If you want to set the job to start every hour, use the following:

Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

cron(0 [00-23] ? * * *)

  • If you want to run the job one time, immediately, use the following keyword:

NOW

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)
  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
  • Every two hours starting at midnight: cron(0 0/2 ? * * *)
  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.

You can also specify the keyword NOW to run the monitoring job immediately, one time, without recurring.

Returns:

  • (String)

See Also:



1713
1714
1715
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 1713

def schedule_expression
  @schedule_expression
end

Class Method Details

.jsii_properties ⇒ Object 



1737
1738
1739
1740
1741
1742
1743
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 1737

def self.jsii_properties
  {
    :schedule_expression => "scheduleExpression",
    :data_analysis_end_time => "dataAnalysisEndTime",
    :data_analysis_start_time => "dataAnalysisStartTime",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 1745

def to_jsii
  result = {}
  result.merge!({
    "scheduleExpression" => @schedule_expression,
    "dataAnalysisEndTime" => @data_analysis_end_time,
    "dataAnalysisStartTime" => @data_analysis_start_time,
  })
  result.compact
end