三歩あるけば物も忘れる

RunCommand-AmazonCloudWatch-ManageAgent

CloudWatch-Agentを操作できるRunCommand
細かな動作は確認中ですが、ssmパラメータストアから連携したい場合、[amazon-cloudwatch-agent.toml]を再作成して欲しいので下記の指定が良さそう。
・Action：Configure
・Mode：環境に合わせて
・Optional Configuration Source：ssm
・Optional Configuration Location:パラメータストアのパラメータ名
・Optional Restart：yes

下記2つはよくわからんが悪さもしない
・Optional Open Telemetry Collector Configuration Source
・Optional Open Telemetry Collector Configuration Location

前提

以下の通りディレクトリ名を勝手に命名して説明する。

通称	説明	Windows	Linux
InstDir	CloudWatchAgentのインストールディレクトリ	C:\Program Files\Amazon\AmazonCloudWatchAgent	/opt/aws/amazon-cloudwatch-agent/bin/
ConfDir	amazon-cloudwatch-agent.toml作成の元となる Configが配置されるディレクトリ	C:\ProgramData\Amazon\AmazonCloudWatchAgent\Configs	/opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.d
TomlDir	tomlファイルが配置されるディレクトリ・amazon-cloudwatch-agent.toml ・common-config.toml	C:\ProgramData\Amazon\AmazonCloudWatchAgent	/opt/aws/amazon-cloudwatch-agent/etc/

コマンドのパラメータ

■Action

	説明
パラメータ	Optional Restart がNoの場合	Optional Restart がYesの場合
Configure	[ConfDir]にRunCommandで指定したConfigファイルを作成する。 [ConfDir]のConfigファイルから[TomlDir]の[amazon-cloudwatch-agent.toml]を再作成する。	左記の動作に加えて、CloudWatchAgentを実行する。
Configure(append)	[ConfDir]に既存Configファイルを残し、RunCommandで指定したConfigファイルを追加作成する。既存ConfigファイルがRunCommandで指定するConfigファイルと同名の場合は上書きする。 [ConfDir]のConfigファイルから[TomlDir]の[amazon-cloudwatch-agent.toml]を再作成する。	[TomlDir]の[amazon-cloudwatch-agent.toml]を再作成してCloudWatchAgentを実行する
Configure(remove)	[ConfDir]のRunCommandで指定したConfigファイルをConfigファイル削除する。「Optional Configuration Source」がALL：全て、ssmとdefaultは指定できる。	[ConfDir]に[default]ファイルを作成する。 [ConfDir]のConfigファイルから[TomlDir]の[amazon-cloudwatch-agent.toml]を再作成してCloudWatchAgentを実行する。
start	[TomlDir]の[amazon-cloudwatch-agent.toml]でCloudWatchAgentを実行する。上記ファイルが無い場合[ConfDir]に[default]ファイルを作成し、[TomlDir]の[amazon-cloudwatch-agent.toml]を作成する。	左記の動作に加えて、CloudWatchAgentを実行する。
status	CloudWatchAgentのステータスを表示	左記の動作に加えて、CloudWatchAgentを実行する。
stop	CloudWatchAgentを停止する	何もしない

■Mode ※不足項目は別途調査する、取得できるパラメータの違い？

パラメータ	説明	備考
ec2	EC2インスタンスではこちらを選択、メタデータから何か拾ってくるっぽい	恐らくホスト名、リージョンを取得
onPremise	onPremiseではこちらを選択、ローカルファイルから何か拾ってくるっぽい	恐らくホスト名、リージョンを取得
auto	EC2かonPremiseか良しなにやってくれる

■Optional Configuration Source ※不足項目は別途調査する、ソースの指定だが

パラメータ	説明	備考
default	defaultコンフィグを利用する際に選択
ssm	パラメータストアを指定する際に選択
all	Configure(remove)でConfDir配下のファイルを削除する際に選択

■Optional Configuration Location

ケース	説明	備考
Sourceがdefaultの場合	指定しない
Sourceがssmの場合	パラメータストアのパラメータ名を指定する
Sourceがallの場合	指定しない

■Optional Open Telemetry Collector Configuration Source
わからん

■Optional Open Telemetry Collector Configuration Location
わからん

■Optional Restart

パラメータ	説明	備考
Yes	CloudWatchAgentを再起動(停止/起動)する	Actionがstopの時は無効
No	CloudWatchAgentを再起動(停止/起動)しない

ターゲット

以下のターゲットから選択する
・タグ指定
・インスタンス指定
・リソースグループ指定

その他のパラメータ

レート制御

出力オプション

SNS 通知

AWS, SystemsManager, RunCommand, AmazonCloudWatch-ManageAgent

目次