メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::SSM::Association

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

トピック

構文

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

JSON

Copy
{ "Type" : "AWS::SSM::Association", "Properties" : { "DocumentVersion" : String, "InstanceId" : String, "Name" : String, "Parameters" : { String: [String, ...] }, "ScheduleExpression" : String, "Targets" : [ Targets ] } }

YAML

Copy
Type: "AWS::SSM::Association" Properties: DocumentVersion: String InstanceId: String Name: String Parameters: String: - String ScheduleExpression: String Targets: - Targets

プロパティ

DocumentVersion

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

Required: No

Type: String

更新に伴う要件: 中断はありません。

InstanceId

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

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

Type: String

更新に伴う要件: 置換

Name

SSM ドキュメントの名前。

Required: Yes

Type: String

更新に伴う要件: 置換

Parameters

SSM ドキュメントがランタイム時に使用するパラメーター値。

Required: No

Type: 文字列から文字列のリストへのマッピング

更新に伴う要件: 中断はありません。

ScheduleExpression

関連付けがターゲットにいつ適用されるかを指定する Cron 式。CRON 式の使用方法については、「Systems Manager の CRON 式および RATE 式を使用する」を参照してください。

Required: No

Type: String

更新に伴う要件: 中断はありません。

Targets

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

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

Amazon EC2 Systems Manager 関連付けのターゲットType: リスト

更新に伴う要件: 置換

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

JSON

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

YAML

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

このページの内容: