# mon-put-metric-alarm
<a name="cli-mon-put-metric-alarm"></a>

## 説明
<a name="w2aab9c51b3"></a>

アラームを作成または更新し、指定された CloudWatch メトリクスにそのアラームを関連付けます。また、このコマンドを使用して、1 つのアラームに 1 つ以上の Amazon Simple Notification Service (Amazon SNS) リソースを関連付けることもできます。

この操作でアラームを作成するとすぐ、アラームの状態が INSUFFICIENT\$1DATA になります。アラームは評価され、その StateValue は適切に設定されます。その後、StateValue と関連付けられたアクションが実行されます。

**注記**  
既存のアラームを更新しても、StateValue は変更されません。

## 構文
<a name="w2aab9c51b5"></a>

 ****mon-put-metric-alarm** AlarmName --comparison-operator *value* --evaluation-periods *value* --metric-name *value* --namespace *value* --period *value* [--statistic *value*] [--extendedstatistic *value*] --threshold *value* [--actions-enabled *value*] [--alarm-actions *value*[,*value*...] ] [--alarm-description *value*] [--dimensions "key1=*value1*,key2=*value2*..."] [--ok-actions *value*[,*value*...] ] [--unit *value*] [--insufficient-data-actions *value*[,*value*...]] [Common Options] ** 

## オプション
<a name="w2aab9c51b7"></a>


| 名前 | 説明 | 
| --- | --- | 
|  `AlarmName` ``   |  更新または作成するアラームの名前。名前は AWS アカウント内で一意でなければなりません。この値は `--alarm-name` を使用して設定することもできます。 タイプ: 引数 有効値: UTF-8 文字列。 デフォルト: N/A 必須: はい  | 
|  `--actions-enabled` `VALUE`   |  アラームの状態が変わったときにアクションを実行するかどうかを指定します。 タイプ: ブール値 有効値: True または False デフォルト: True 必須: いいえ  | 
|  `--alarm-actions` `VALUE1,VALUE2,VALUE3... `   |  このアラームが ALARM 以外の状態から ALARM 状態に移行したときに実行するアクション (最大 5 個)。各アクションは Amazon リソースネーム (ARN) として指定されます。アラームアクションを使用して、Amazon SNS トピックへの公開、Amazon EC2 Auto Scaling ポリシーのアクティブ化、または Amazon EC2 インスタンスの停止、終了、復旧を行うことができます。 AWS Identity and Access Management (IAM) アカウントを使用してアラームを作成または変更する場合、次の Amazon EC2 の許可が必要です。 Amazon EC2 インスタンスステータスメトリクスに対するすべてのアラーム向けの `ec2:DescribeInstanceStatus` と `ec2:DescribeInstances` `ec2:StopInstances`。停止アクションを含むアラーム用。 `ec2:TerminateInstances`。終了アクションを含むアラーム用。 `ec2:DescribeInstanceRecoveryAttribute` と `ec2:RecoverInstances`。復旧アクションを含むアラーム用。  Amazon CloudWatch に対する読み取り/書き込み権限は持っているが、Amazon EC2 に対する権限を持っていない場合でも、アラームを作成できますが、停止または終了アクションは Amazon EC2 インスタンスでは実行されません。ただし、関連付けられている Amazon EC2 API の使用許可が後で付与される場合、以前に作成したアラームアクションは実行されるようになります。IAM のアクセス許可の詳細については、IAM ユーザーガイドの「[アクセス許可とポリシー](https://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html)」を参照してください。 IAM ロール (Amazon EC2 インスタンスプロファイルなど) を使用している場合、アラームのアクションを使用してインスタンスを停止または終了することはできません。ただし、アラームの状態を確認して、Amazon SNS 通知や Amazon EC2 Auto Scaling ポリシーなど、その他のアクションを実行することはできます。 AWS Security Token Service (AWS STS) で付与された一時的なセキュリティ認証情報を使用している場合、アラームのアクションを使用して Amazon EC2 インスタンスを停止または終了することはできません。  タイプ: 文字列 有効な値: Amazon SNS トピックの ARN、Auto Scaling ポリシー、または Amazon EC2 インスタンスを停止、終了、回復するための ARN。 デフォルト: N/A 必須: いいえ  | 
|  `--alarm-description` `VALUE`   |  アラームの説明。 タイプ: 文字列 有効値: 文字長が 1 から 255 の Unicode 文字列 デフォルト: N/A 必須: いいえ  | 
|  `--comparison-operator` `VALUE`   |  データポイントとしきい値の比較に使用する比較演算子。 タイプ: 列挙法 有効値: GreaterThanOrEqualToThreshold、GreaterThanThreshold、LessThanThreshold、または LessThanOrEqualToThreshold のいずれか デフォルト: N/A 必須: はい  | 
|  `--dimensions` `"key1=value1,key2=value2..."`   |  作成するアラームに関連して作成するメトリクスのディメンション。ディメンションは 2 つの方法で指定でき、形式を組み合わせて、あるいは互換的に使用することができます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/AmazonCloudWatch/latest/cli/cli-mon-put-metric-alarm.html) タイプ: マップ 有効値: name=value 形式の文字列。ここで、key はディメンション名、value はディメンションの値です。ディメンション名と値は、文字長が 1 から 250 の ANSI 文字列である必要があります。最大 10 ディメンションが許可されています。 デフォルト: N/A 必須: いいえ  | 
|  `--evaluation-periods` `VALUE`   |  アラームのステータスを決定するためにメトリクスの値としきい値を比較する連続した期間の数。 タイプ: 整数 有効値: 0 より大きい数値 デフォルト: N/A 必須: はい  | 
|  `--metric-name` `VALUE`   |  アラームを設置するメトリクスの名前。 タイプ: 引数 有効値: 文字長が 1 から 250 の ANSI 文字列 デフォルト: N/A 必須: はい  | 
|  `--namespace` `VALUE`   |  アラームを設置するメトリクスの名前空間。名前空間の詳細については、[AWS の名前空間](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/aws-namespaces.html)を参照してください。 タイプ: 文字列 有効値: 文字長が 1 から 250 の ANSI 文字列 デフォルト: N/A 必須: はい  | 
|  `--ok-actions` `VALUE1,VALUE2,VALUE3...`   |  このアラームが OK 以外の状態から OK 状態に移行したときに実行するアクション (最大 5 個)。各アクションは Amazon リソースネーム (ARN) として指定されます。 タイプ: 文字列 有効値: 有効な ARN 識別子 デフォルト: N/A 必須: いいえ  | 
|  `--period` `VALUE`   |  アラームを設置するメトリクスの期間 (秒単位)。 タイプ: 引数 有効値: 秒数、60 の倍数。 デフォルト: N/A 必須: はい  | 
|  `--statistic` `VALUE`   |  アラームを設置するメトリクスの統計。 タイプ: 列挙法 有効値: SampleCount、Average、Sum、Minimum、または Maximum デフォルト: N/A 必須: --statistic または --extendedstatistic のどちらかを指定する必要があります。  | 
|  `--extendedstatistic` `VALUE`   |  アラームを設置するメトリクスのパーセンタイル統計。 タイプ: 文字列 有効な値: 小数点以下 2 桁までの任意のパーセンタイル (p95.45 など)。 デフォルト: N/A 必須: --statistic または --extendedstatistic のどちらかを指定する必要があります。  | 
|   `--threshold` `VALUE`   |  アラームの状態を決定するためにデータポイントと比較するしきい値。 型: 倍精度 有効値: 倍精度浮動小数点数。これらの値はすべて、1E-130 から 1E130 の間の数値である必要があります。 デフォルト: N/A 必須: はい  | 
|  `--unit` `VALUE`   |  アラームを設置するメトリクスの単位。 タイプ: 列挙法 有効な値: 以下のいずれかです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/AmazonCloudWatch/latest/cli/cli-mon-put-metric-alarm.html) デフォルト: N/A 必須: いいえ  | 
|  `--insufficient-data-actions` `VALUE1,VALUE2,VALUE3...`   |  このアラームが INSUFFICIENT\$1DATA 以外の状態から INSUFFICIENT\$1DATA 状態に移行したときに実行するアクション (最大 5 個)。各アクションは Amazon リソースネーム (ARN) として指定されます。 タイプ: 文字列 有効値: 有効な ARN 識別子 デフォルト: N/A 必須: いいえ  | 

## 一般的なオプション
<a name="w2aab9c51b9"></a>


| 名前 | 説明 | 
| --- | --- | 
|  `--aws-credential-file` `VALUE`   |  AWS 認証情報を含むファイルの場所。環境変数 `AWS_CREDENTIAL_FILE` を使用して、この値を設定できます。環境変数またはパスで指定する認証情報ファイルの場所は、実在のものでなければなりません。存在しない場合、リクエストは失敗します。すべての CloudWatch リクエストに、アクセスキー ID とシークレットアクセスキーを使用して署名する必要があります。 タイプ: 文字列 有効な値: アクセスキー ID とシークレットアクセスキーを含むファイルへの有効なパス。 デフォルト: 設定されている場合は、環境変数 `AWS_CREDENTIAL_FILE` を使用します。  | 
|  `-C, --ec2-cert-file-path` `VALUE`   |  リクエストに署名するための EC2 証明書ファイルの場所。環境変数 `EC2_CERT` を使用して、この値を指定できます。 タイプ: 文字列 有効な値: Amazon EC2 または AWS Identity and Access Management によって提供される PEM ファイルへの有効なファイルパス。 デフォルト: 設定されている場合は、環境変数 `EC2_CERT` を使用します。  | 
|   `--connection-timeout` `VALUE`   |  接続タイムアウト値 (秒)。 タイプ: 整数 有効な値: 任意の正の整数。 デフォルト: 30  | 
|   `--delimiter` `VALUE`   |  長い結果を区切って表示する際に使用する区切り記号。 タイプ: 文字列 有効な値: 任意の文字列。 デフォルト: コンマ（,）  | 
|   `--headers` ``   |  表形式の結果または区切られた結果を表示する場合に、列ヘッダーを含めます。XML 形式の結果を表示する場合に、サービスリクエストから HTTP ヘッダーを返します (該当する場合)。 タイプ: フラグ 有効な値: 存在する場合は、ヘッダーを表示します。 デフォルト: `--headers` オプションは、デフォルトでオフになっています。  | 
|   `-I, --access-key-id` `VALUE`   |  リクエストの署名で、シークレットキーと組み合わせて使用するアクセスキー ID。これは、––secret-key と組み合わせて使用する必要があります。単独で使用すると、このオプションは無視されます。CloudWatch へのすべてのリクエストには署名が必要です。署名がないと、リクエストは拒否されます。 タイプ: 文字列 有効な値: 有効なアクセスキー ID。 デフォルト: なし  | 
|   `-K, --ec2-private-key-file-path` `VALUE`   |  リクエストに署名するために使用されるプライベートキー。パブリック/プライベートキーを使用すると、CLI が SOAP を使用します。リクエストは、パブリック証明書とプライベートキーを使用して署名されます。このパラメータは、`EC2_CERT` と組み合わせて使用する必要があります。単独で使用すると、この値は無視されます。設定されている場合は、環境変数の値 `EC2_PRIVATE_KEY` が使用され、このオプションは指定されません。環境変数 `AWS_CREDENTIAL_FILE` が設定されている場合、このオプションは無視されます。設定されていない場合は、`--aws-credentials-file` が使用されます。CloudWatch へのすべてのリクエストには署名が必要です。署名がないと、リクエストは拒否されます。 タイプ: 文字列 有効な値: 有効な ASN.1 プライベートキーへのパス。 デフォルト: なし  | 
|   `--region` `VALUE`   |  リクエストの送信先のリージョン。環境変数 `EC2_REGION` を使用して、この値を指定できます。このリージョンは、CloudWatch の呼び出しに使用する URL の作成で使用され、Amazon Web Services (AWS) の有効なリージョンである必要があります。 タイプ: 文字列 有効な値: 任意の AWS リージョン (例: us-east-1) デフォルト: 環境変数 `EC2_REGION` が設定されている場合を除き、us-east-1  | 
|   `S, --secret-key` `VALUE`   |  リクエストの署名で、アクセスキー ID と組み合わせて使用するシークレットアクセスキー。このパラメータは、`--access-key-id` と組み合わせて使用する必要があります。単独で使用すると、このオプションは無視されます。 タイプ: 文字列 有効な値: アクセスキー ID デフォルト: なし  | 
|   `--show-empty-fields` ``   |  プレースホルダーとして (nil) を使用して空のフィールドを表示し、このデータがリクエストされなかったことを示します。 タイプ: フラグ 有効な値: なし デフォルト: デフォルトでは、空のフィールドは表示されません。  | 
|   `--show-request` ``   |  CLI が AWS の呼び出しに使用する URL を表示します。 タイプ: フラグ 有効な値: なし デフォルト: false  | 
|   `--show-table, --show-long, --show-xml, --quiet` ``   |  結果の表示形式として、表形式、区切り形式 (長い)、XML 形式、または出力なし (非表示) を指定します。`--show-table` は、固定列幅のフォームにデータのサブネットを表示します。`--show-long` は、返されたすべての値を文字で区切って表示します。`--show-xml` は、サービスから返されたデータをそのままの状態で表示します。`--quiet` は、すべての標準出力を非表示にします。すべてのオプションは相互に排他的で、優先度は、`--show-table`、`--show-long`、`--show-xml`、`--quiet` の順になります。 タイプ: フラグ 有効な値: なし デフォルト: `--show-table`  | 
|   `-U, --url` `VALUE`   |  CloudWatch への接続に使用する URL。環境変数 `AWS_CLOUDWATCH_URL` を使用して、この値を設定できます。この値は有効な URL を作成するために `--region` と組み合わせて使用されます。このオプションは、サービス呼び出しの URL をオーバーライドします。 タイプ: 文字列 有効な値:有効な HTTP または HTTPS URL。 デフォルト: 設定されている場合は、`AWS_CLOUDWATCH_URL` で指定した値を使用します。  | 

## Output
<a name="w2aab9c51c11"></a>

このコマンドで、指定したメトリクスに関連付けられるアラームを作成または更新します。

Amazon CloudWatch CLI は、stderr でエラーを表示します。

## 例
<a name="w2aab9c51c13"></a>

### リクエスト例
<a name="w2aab9c51c13b2"></a>

次の例で作成するアラームでは、EC2 インスタンスの CPU 使用率が 1 分単位の期間を 3 つ連続して 90% を超えたときに、トピックにメッセージを発行します。

```
mon-put-metric-alarm --alarm-name my-alarm --alarm-description "some desc" \
--metric-name CPUUtilization --namespace AWS/EC2 --statistic Average  --period 60 --threshold 90 \
--comparison-operator GreaterThanThreshold  --dimensions InstanceId=i-abcdef --evaluation-periods 3  \
--unit Percent --alarm-actions arn:aws:sns:us-east-1:1234567890:my-topic
```

## 関連トピック
<a name="w2aab9c51c15"></a>

### ダウンロード
<a name="w2aab9c51c15b2"></a>
+ [コマンドラインインターフェイスをセットアップする](SetupCLI.md)

### 関連アクション
<a name="w2aab9c51c15b4"></a>
+ [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html)

### 関連コマンド
<a name="w2aab9c51c15b6"></a>
+  [mon-put-data](cli-mon-put-data.md)