

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# CloudWatch 指標
<a name="cloudwatch-metrics-rule-action"></a>

CloudWatch 指標 (`cloudwatchMetric`) 動作擷取 Amazon CloudWatch 指標。您可以指定指標命名空間、名稱、值、單位、時間戳記。

## 要求
<a name="cloudwatch-metrics-rule-action-requirements"></a>

此規則動作具有下列需求：
+  AWS IoT 可以擔任以執行`cloudwatch:PutMetricData`操作的 IAM 角色。如需詳細資訊，請參閱[授予 AWS IoT 規則所需的存取權](iot-create-role.md)。

  在 AWS IoT 主控台中，您可以選擇或建立角色， AWS IoT 以允許 執行此規則動作。

## Parameters
<a name="cloudwatch-metrics-rule-action-parameters"></a>

當您使用此動作建立 AWS IoT 規則時，您必須指定下列資訊：

`metricName`  
CloudWatch 指標名稱。  
支援[替代範本](iot-substitution-templates.md)：是

`metricNamespace`  
CloudWatch 指標命名空間名稱。  
支援[替代範本](iot-substitution-templates.md)：是

`metricUnit`  
CloudWatch 支援的指標單位。  
支援[替代範本](iot-substitution-templates.md)：是

`metricValue`  
包含 CloudWatch 指標值的字串。  
支援[替代範本](iot-substitution-templates.md)：是

`metricTimestamp`  
(選用) 包含 Unix epoch 時間中時間戳記 (以秒為單位來表達) 的字串。預設為目前的 Unix epoch 時間。  
支援[替代範本](iot-substitution-templates.md)：是

`roleArn`  
允許存取 CloudWatch 指標的 IAM 角色。如需詳細資訊，請參閱[要求](#cloudwatch-metrics-rule-action-requirements)。  
支援[替代範本](iot-substitution-templates.md)：否

## 範例
<a name="cloudwatch-metrics-rule-action-examples"></a>

下面的 JSON 範例定義 AWS IoT 規則中的 CloudWatch 指標動作。

```
{
    "topicRulePayload": {
        "sql": "SELECT * FROM 'some/topic'", 
        "ruleDisabled": false, 
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "cloudwatchMetric": {
                    "metricName": "IotMetric",
                    "metricNamespace": "IotNamespace", 
                    "metricUnit": "Count",
                    "metricValue": "1",
                    "metricTimestamp": "1456821314",
                    "roleArn": "arn:aws:iam::123456789012:role/aws_iot_cw"
                }
            }
        ]
    }
}
```

下列 JSON 範例使用 AWS IoT 規則中的替代範本來定義 CloudWatch 指標動作。

```
{
    "topicRulePayload": {
        "sql": "SELECT * FROM 'some/topic'",
        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "cloudwatchMetric": {
                    "metricName": "${topic()}",
                    "metricNamespace": "${namespace}",
                    "metricUnit": "${unit}",
                    "metricValue": "${value}",
                    "roleArn": "arn:aws:iam::123456789012:role/aws_iot_cw"
                }
            }
        ]
    }
}
```

## 另請參閱
<a name="cloudwatch-metrics-rule-action-see-also"></a>
+ 《Amazon CloudWatch 使用者指南》**中的[什麼是 Amazon CloudWatch？](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/)
+ 《Amazon CloudWatch 使用者指南》**中的[使用 Amazon CloudWatch 指標](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/working_with_metrics.html)