DATASOURCE::DTS::JobMonitorRule - Resource Orchestration Service

DATASOURCE::DTS::JobMonitorRule type is used to query an alert rule of a Data Transmission Service (DTS) task.

Syntax

{
  "Type": "DATASOURCE::DTS::JobMonitorRule",
  "Properties": {
    "DtsJobId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DtsJobId

String

Yes

The ID of the data migration, data synchronization, or change tracking task.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

Type: the type of the alert rule.
DtsJobId: the ID of the data migration, data synchronization, or change tracking task.
Phone: the mobile number that receives notifications when alerts are triggered.
State: the state that indicates whether the alert rule is enabled.
Times: the number of statistical periods of the incremental data verification task.
Period: the statistical period of the incremental data verification task. Unit: minutes.
DelayRuleTime: the threshold for triggering latency alerts. Unit: seconds.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DtsJobId:
    Type: String
    Description:
      en: The ID of the data migration, data synchronization, or change tracking task.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DTS::JobMonitorRule
    Properties:
      DtsJobId:
        Ref: DtsJobId
Outputs:
  Type:
    Description: The type of the monitoring rule.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Type
  DtsJobId:
    Description: The ID of the data migration, data synchronization, or change tracking task.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DtsJobId
  Phone:
    Description: The mobile phone numbers that receive alert notifications. Multiple mobile numbers are separated by commas (,).
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Phone
  State:
    Description: 'Indicates whether the monitoring rule is enabled. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - State
  Times:
    Description: The number of cycles for the incremental validation task.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Times
  Period:
    Description: The statistical period for incremental validation tasks, in minutes.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Period
  DelayRuleTime:
    Description: The threshold that triggers the alert.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DelayRuleTime

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DtsJobId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the data migration, data synchronization, or change tracking task."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DTS::JobMonitorRule",
      "Properties": {
        "DtsJobId": {
          "Ref": "DtsJobId"
        }
      }
    }
  },
  "Outputs": {
    "Type": {
      "Description": "The type of the monitoring rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Type"
        ]
      }
    },
    "DtsJobId": {
      "Description": "The ID of the data migration, data synchronization, or change tracking task.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DtsJobId"
        ]
      }
    },
    "Phone": {
      "Description": "The mobile phone numbers that receive alert notifications. Multiple mobile numbers are separated by commas (,).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Phone"
        ]
      }
    },
    "State": {
      "Description": "Indicates whether the monitoring rule is enabled. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "State"
        ]
      }
    },
    "Times": {
      "Description": "The number of cycles for the incremental validation task.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Times"
        ]
      }
    },
    "Period": {
      "Description": "The statistical period for incremental validation tasks, in minutes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Period"
        ]
      }
    },
    "DelayRuleTime": {
      "Description": "The threshold that triggers the alert.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DelayRuleTime"
        ]
      }
    }
  }
}