Class CfnMonitoringScheduleAlert

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleAlert
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMonitoringScheduleAlertRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:11.514Z") @Stability(Stable) public class CfnMonitoringScheduleAlert extends CfnResource implements IInspectable, IMonitoringScheduleAlertRef
Resource type definition for AWS::SageMaker::MonitoringScheduleAlert.

A monitoring alert associated with a SageMaker monitoring schedule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnMonitoringScheduleAlert cfnMonitoringScheduleAlert = CfnMonitoringScheduleAlert.Builder.create(this, "MyCfnMonitoringScheduleAlert")
         .datapointsToAlert(123)
         .evaluationPeriod(123)
         .monitoringAlertName("monitoringAlertName")
         .monitoringScheduleName("monitoringScheduleName")
         .build();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnMonitoringScheduleAlert

      protected CfnMonitoringScheduleAlert(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnMonitoringScheduleAlert

      protected CfnMonitoringScheduleAlert(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnMonitoringScheduleAlert

      @Stability(Stable) public CfnMonitoringScheduleAlert(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMonitoringScheduleAlertProps props)
      Create a new AWS::SageMaker::MonitoringScheduleAlert.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • arnForMonitoringScheduleAlert

      @Stability(Stable) @NotNull public static String arnForMonitoringScheduleAlert(@NotNull IMonitoringScheduleAlertRef resource)
      Parameters:
      resource - This parameter is required.
    • isCfnMonitoringScheduleAlert

      @Stability(Stable) @NotNull public static Boolean isCfnMonitoringScheduleAlert(@NotNull Object x)
      Checks whether the given object is a CfnMonitoringScheduleAlert.

      Parameters:
      x - This parameter is required.
    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrActions

      @Stability(Stable) @NotNull public IResolvable getAttrActions()
      A list of alert actions taken in response to an alert going into InAlert status.
    • getAttrAlertStatus

      @Stability(Stable) @NotNull public String getAttrAlertStatus()
      The current status of the alert.
    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the monitoring schedule alert.
    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      A timestamp that indicates when the alert was created.
    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      A timestamp that indicates when the alert was last updated.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource
    • getMonitoringScheduleAlertRef

      @Stability(Stable) @NotNull public MonitoringScheduleAlertReference getMonitoringScheduleAlertRef()
      A reference to a MonitoringScheduleAlert resource.
      Specified by:
      getMonitoringScheduleAlertRef in interface IMonitoringScheduleAlertRef
    • getDatapointsToAlert

      @Stability(Stable) @NotNull public Number getDatapointsToAlert()
      Within EvaluationPeriod, how many execution failures will raise an alert.
    • setDatapointsToAlert

      @Stability(Stable) public void setDatapointsToAlert(@NotNull Number value)
      Within EvaluationPeriod, how many execution failures will raise an alert.
    • getEvaluationPeriod

      @Stability(Stable) @NotNull public Number getEvaluationPeriod()
      The number of most recent monitoring executions to consider when evaluating alert status.
    • setEvaluationPeriod

      @Stability(Stable) public void setEvaluationPeriod(@NotNull Number value)
      The number of most recent monitoring executions to consider when evaluating alert status.
    • getMonitoringAlertName

      @Stability(Stable) @NotNull public String getMonitoringAlertName()
      The name of the monitoring alert.
    • setMonitoringAlertName

      @Stability(Stable) public void setMonitoringAlertName(@NotNull String value)
      The name of the monitoring alert.
    • getMonitoringScheduleName

      @Stability(Stable) @NotNull public String getMonitoringScheduleName()
      The name of the monitoring schedule.
    • setMonitoringScheduleName

      @Stability(Stable) public void setMonitoringScheduleName(@NotNull String value)
      The name of the monitoring schedule.