ALIYUN::DTS::JobMonitorRule - Resource Orchestration Service

The ALIYUN::DTS::JobMonitorRule resource creates a job monitoring rule.

Syntax

{
  "Type": "ALIYUN::DTS::JobMonitorRule",
  "Properties": {
    "DtsJobId": String,
    "Type": String,
    "DelayRuleTime": Integer,
    "Phones": List,
    "Period": Integer,
    "State": String,
    "Times": Integer
  }
}

Properties

Property	Type	Required	Editable	Description	Constraints
DtsJobId	String	Yes	No	The ID of the migration, synchronization, or subscription task.	None
Type	String	Yes	No	The type of the monitoring rule.	Valid values: `delay`: delay alarm. `error`: error alarm.
DelayRuleTime	Integer	No	Yes	The threshold for triggering a delay alarm.	Unit: seconds.
Period	Integer	No	Yes	The monitoring period of the incremental verification task.	Unit: minutes. Note The supported values are 1, 3, 5, and 30.
Phones	List	No	Yes	The phone numbers of the contacts to be notified of alarms. Separate multiple phone numbers with commas (,).	None
State	String	No	Yes	Specifies whether to enable the monitoring rule.	Valid values: `Y`: enabled `N`: disabled
Times	Integer	No	Yes	The number of monitoring periods for the incremental verification task.	None

Return values

Fn::GetAtt

Type: The type of the monitoring rule. Valid values: delay and error.
DtsJobId: The ID of the migration, synchronization, or subscription task. You can call the DescribeDtsJobs operation to obtain this ID.
Phones: The phone numbers of the contacts to be notified of alarms. Multiple phone numbers are separated by commas (,).
State: The status of the monitoring rule. Valid values: Y (enabled) and N (disabled).
Times: The number of monitoring periods for the incremental verification task.
Period: The monitoring period of the incremental verification task. Unit: minutes.
DelayRuleTime: The threshold for triggering a delay alarm. Unit: seconds.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DelayRuleTime:
    Description:
      en: The threshold for triggering a delay alarm, in seconds.
    Required: false
    Type: Number
  DtsJobId:
    Description:
      en: The ID of the migration, synchronization, or subscription task. You can call the DescribeDtsJobs operation to obtain this ID.
    Required: true
    Type: String
  Period:
    AllowedValues:
      - 1
      - 3
      - 5
      - 30
    AssociationProperty: PayPeriod
    Description:
      en: 'The monitoring period of the incremental verification task, in minutes. The supported values are 1, 3, 5, and 30.'
    Required: false
    Type: Number
  Phones:
    Description:
      en: The phone numbers of the contacts to be notified of alarms. Separate multiple phone numbers with commas (,).
    MaxLength: 10
    MinLength: 0
    Required: false
    Type: Json
  State:
    AllowedValues:
      - Y
      - N
    Default: Y
    Description:
      en: 'Specifies whether to enable the monitoring rule. Valid values: Y (enabled) and N (disabled). Default: Y.'
    Required: false
    Type: String
  Times:
    Description:
      en: The number of monitoring periods for the incremental verification task.
    Required: false
    Type: Number
  Type:
    AllowedValues:
      - delay
      - error
    Description:
      en: 'The type of the monitoring rule. Valid values: delay (delay alarm) and error (error alarm).'
    Required: true
    Type: String
Resources:
  ExtensionResource:
    Properties:
      DelayRuleTime:
        Ref: DelayRuleTime
      DtsJobId:
        Ref: DtsJobId
      Period:
        Ref: Period
      Phones:
        Ref: Phones
      State:
        Ref: State
      Times:
        Ref: Times
      Type:
        Ref: Type
    Type: ALIYUN::DTS::JobMonitorRule
Outputs:
  DelayRuleTime:
    Description: The threshold for triggering a delay alarm, in seconds.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DelayRuleTime
  DtsJobId:
    Description: The ID of the migration, synchronization, or subscription task.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DtsJobId
  Period:
    Description: 'The monitoring period of the incremental verification task, in minutes.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Period
  Phones:
    Description: The phone numbers of the contacts to be notified of alarms. Separate multiple phone numbers with commas (,).
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Phones
  State:
    Description: The status of the monitoring rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - State
  Times:
    Description: The number of monitoring periods for the incremental verification task.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Times
  Type:
    Description: The type of the monitoring rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Type

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Type": {
      "Type": "String",
      "Description": {
        "en": "The type of the monitoring rule. Valid values: delay (delay alarm) and error (error alarm)."
      },
      "AllowedValues": [
        "delay",
        "error"
      ],
      "Required": true
    },
    "DtsJobId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the migration, synchronization, or subscription task. You can call the DescribeDtsJobs operation to obtain this ID."
      },
      "Required": true
    },
    "Phones": {
      "Type": "Json",
      "Description": {
        "en": "The phone numbers of the contacts to be notified of alarms. Separate multiple phone numbers with commas (,)."
      },
      "Required": false,
      "MinLength": 0,
      "MaxLength": 10
    },
    "State": {
      "Type": "String",
      "Description": {
        "en": "Specifies whether to enable the monitoring rule. Valid values: Y (enabled) and N (disabled). Default: Y."
      },
      "AllowedValues": [
        "Y",
        "N"
      ],
      "Required": false,
      "Default": "Y"
    },
    "Times": {
      "Type": "Number",
      "Description": {
        "en": "The number of monitoring periods for the incremental verification task."
      },
      "Required": false
    },
    "Period": {
      "Type": "Number",
      "AssociationProperty": "PayPeriod",
      "Description": {
        "en": "The monitoring period of the incremental verification task, in minutes. The supported values are 1, 3, 5, and 30."
      },
      "AllowedValues": [
        1,
        3,
        5,
        30
      ],
      "Required": false
    },
    "DelayRuleTime": {
      "Type": "Number",
      "Description": {
        "en": "The threshold for triggering a delay alarm, in seconds."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::DTS::JobMonitorRule",
      "Properties": {
        "Type": {
          "Ref": "Type"
        },
        "DtsJobId": {
          "Ref": "DtsJobId"
        },
        "Phones": {
          "Ref": "Phones"
        },
        "State": {
          "Ref": "State"
        },
        "Times": {
          "Ref": "Times"
        },
        "Period": {
          "Ref": "Period"
        },
        "DelayRuleTime": {
          "Ref": "DelayRuleTime"
        }
      }
    }
  },
  "Outputs": {
    "Type": {
      "Description": "The type of the monitoring rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Type"
        ]
      }
    },
    "DtsJobId": {
      "Description": "The ID of the migration, synchronization, or subscription task.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DtsJobId"
        ]
      }
    },
    "Phones": {
      "Description": "The phone numbers of the contacts to be notified of alarms. Separate multiple phone numbers with commas (,).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Phones"
        ]
      }
    },
    "State": {
      "Description": "The status of the monitoring rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "State"
        ]
      }
    },
    "Times": {
      "Description": "The number of monitoring periods for the incremental verification task.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Times"
        ]
      }
    },
    "Period": {
      "Description": "The monitoring period of the incremental verification task, in minutes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Period"
        ]
      }
    },
    "DelayRuleTime": {
      "Description": "The threshold for triggering a delay alarm, in seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DelayRuleTime"
        ]
      }
    }
  }
}