AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::SSM::Association

AWS::SSM::Association リソースは、AWS Systems Manager の SSM ドキュメントを設定エージェントを含むマネージドインスタンスと関連付け、ドキュメントを処理します。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "Type" : "AWS::SSM::Association", "Properties" : { "AssociationName" : String, "DocumentVersion" : String, "InstanceId" : String, "Name" : String, "OutputLocation" : InstanceAssociationOutputLocation, "Parameters" : {Key : Value, ...}, "ScheduleExpression" : String, "Targets" : [ Target, ... ] } }

YAML

Type: AWS::SSM::Association Properties: AssociationName: String DocumentVersion: String InstanceId: String Name: String OutputLocation: InstanceAssociationOutputLocation Parameters: Key : Value ScheduleExpression: String Targets: - Target

プロパティ

AssociationName

関連付けの名前。

必須: いいえ

タイプ: 文字列

パターン: ^[a-zA-Z0-9_\-.]{3,128}$

Update requires: No interruption

DocumentVersion

ターゲットと関連付ける SSM ドキュメントのバージョン。

必須: いいえ

タイプ: 文字列

パターン: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Update requires: No interruption

InstanceId

SSM ドキュメントが関連付けられるインスタンスの ID。

InstanceId または Targets プロパティを指定する必要があります。

必須: 条件付き

タイプ: 文字列

パターン: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

Update requires: Replacement

Name

Systems Manager ドキュメントの名前。

必須: はい

タイプ: 文字列

パターン: ^[a-zA-Z0-9_\-.:/]{3,128}$

Update requires: Replacement

OutputLocation

このリクエストのアウトプット詳細を保存する Amazon S3 バケット。

必須: いいえ

タイプ: InstanceAssociationOutputLocation

Update requires: No interruption

Parameters

ドキュメントのランタイム設定のパラメータ。

必須: いいえ

タイプ: ParameterValues のマップ

Update requires: No interruption

ScheduleExpression

関連付けが実行されるときにスケジュールを指定する Cron 式。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 256

Update requires: No interruption

Targets

SSM ドキュメントがコマンドを送信するターゲット。

InstanceId または Targets プロパティを指定する必要があります。

必須: 条件付き

タイプ: Target のリスト

最大: 5

Update requires: Replacement

Systems Manager のドキュメントを特定のインスタンスと関連付ける

次の例は、SSM ドキュメントを特定のインスタンスと関連付けます。インスタンスの ID は myInstanceId パラメータで指定されます。

JSON

"association": { "Type": "AWS::SSM::Association", "Properties": { "Name": { "Ref": "document" }, "Parameters": { "Directory": ["myWorkSpace"] }, "Targets": [{ "Key": "InstanceIds", "Values": [{ "Ref": "myInstanceId" }] }] } }

YAML

association: Type: AWS::SSM::Association Properties: Name: !Ref 'document' Parameters: Directory: ["myWorkSpace"] Targets: - Key: InstanceIds Values: [!Ref 'myInstanceId']

以下の資料も参照してください。