AWS Doc SDK Examples
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
RegisterTaskWithMaintenanceWindow
で を使用する CLI
以下のコード例は、RegisterTaskWithMaintenanceWindow
の使用方法を示しています。
- CLI
-
- AWS CLI
-
例 1: メンテナンスウィンドウにオートメーションタスクを登録するには
次の
register-task-with-maintenance-window
の例では、インスタンスをターゲットとするメンテナンスウィンドウにオートメーションタスクを登録します。aws ssm register-task-with-maintenance-window \ --window-id
"mw-082dcd7649EXAMPLE"
\ --targetsKey=InstanceIds,Values=i-1234520122EXAMPLE
\ --task-arnAWS-RestartEC2Instance
\ --service-role-arnarn:aws:iam::111222333444:role/SSM
--task-typeAUTOMATION
\ --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$LATEST\",\"Parameters\":{\"InstanceId\":[\"{{RESOURCE_ID}}\"]}}}" \ --priority0
\ --max-concurrency1
\ --max-errors1
\ --name"AutomationExample"
\ --description"Restarting EC2 Instance for maintenance"
出力:
{ "WindowTaskId":"11144444-5555-6666-7777-88888888" }
詳細については、AWS Systems Manager ユーザーガイドの「メンテナンスウィンドウ (AWS CLI) でタスクを登録する」を参照してください。
例 2: メンテナンスウィンドウに Lambda タスクを登録するには
次の
register-task-with-maintenance-window
の例では、インスタンスをターゲットとするメンテナンスウィンドウに Lambda タスクを登録します。aws ssm register-task-with-maintenance-window \ --window-id
"mw-082dcd7649dee04e4"
\ --targetsKey=InstanceIds,Values=i-12344d305eEXAMPLE
\ --task-arnarn:aws:lambda:us-east-1:111222333444:function:SSMTestLAMBDA
\ --service-role-arnarn:aws:iam::111222333444:role/SSM
\ --task-typeLAMBDA
\ --task-invocation-parameters '{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier":"$LATEST"}}
' \ --priority0
\ --max-concurrency10
\ --max-errors5
\ --name"Lambda_Example"
\ --description"My Lambda Example"
出力:
{ "WindowTaskId":"22244444-5555-6666-7777-88888888" }
詳細については、AWS Systems Manager ユーザーガイドの「メンテナンスウィンドウ (AWS CLI) でタスクを登録する」を参照してください。
例 3: メンテナンスウィンドウに Run Command タスクを登録するには
次の
register-task-with-maintenance-window
の例では、インスタンスをターゲットとするメンテナンスウィンドウに Run Command タスクを登録します。aws ssm register-task-with-maintenance-window \ --window-id
"mw-082dcd7649dee04e4"
\ --targets"Key=InstanceIds,Values=i-12344d305eEXAMPLE"
\ --service-role-arn"arn:aws:iam::111222333444:role/SSM"
\ --task-type"RUN_COMMAND"
\ --name"SSMInstallPowerShellModule"
\ --task-arn"AWS-InstallPowerShellModule"
\ --task-invocation-parameters "{\"RunCommand\":{\"Comment\":\"\",\"OutputS3BucketName\":\"runcommandlogs\",\"Parameters\":{\"commands\":[\"Get-Module -ListAvailable\"],\"executionTimeout\":[\"3600\"],\"source\":[\"https:\/\/gallery.technet.microsoft.com\/EZOut-33ae0fb7\/file\/1
1
0351\/1\/EZOut.zip\"],\"workingDirectory\":[\"\\\\\"]},\"TimeoutSeconds\":600}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority10
出力:
{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }
詳細については、AWS Systems Manager ユーザーガイドの「メンテナンスウィンドウ (AWS CLI) でタスクを登録する」を参照してください。
例 4: Step Functions タスクをメンテナンスウィンドウに登録するには
次の
register-task-with-maintenance-window
の例では、インスタンスをターゲットとするメンテナンスウィンドウに Step Functions タスクを登録します。aws ssm register-task-with-maintenance-window \ --window-id
"mw-1234d787d6EXAMPLE"
\ --targetsKey=WindowTargetIds,Values=12347414-69c3-49f8-95b8-ed2dcEXAMPLE
\ --task-arnarn:aws:states:us-east-1:111222333444:stateMachine:SSMTestStateMachine
\ --service-role-arnarn:aws:iam::111222333444:role/MaintenanceWindows
\ --task-typeSTEP_FUNCTIONS
\ --task-invocation-parameters '{"StepFunctions":{"Input":"{\"InstanceId\":\"{{RESOURCE_ID}}\"}"}}
' \ --priority0
\ --max-concurrency10
\ --max-errors5
\ --name"Step_Functions_Example"
\ --description"My Step Functions Example"
出力:
{ "WindowTaskId":"44444444-5555-6666-7777-88888888" }
詳細については、AWS Systems Manager ユーザーガイドの「メンテナンスウィンドウ (AWS CLI) でタスクを登録する」を参照してください。
例 5: メンテナンスウィンドウのターゲット ID を使用してタスクを登録するには
次の
register-task-with-maintenance-window
の例では、メンテナンスウィンドウのターゲット ID を使用してタスクを登録します。メンテナンスウィンドウのターゲット ID は、aws ssm register-target-with-maintenance-window
コマンドの出力に含まれていました。この情報はaws ssm describe-maintenance-window-targets
コマンドの出力から取得することもできます。aws ssm register-task-with-maintenance-window \ --targets
"Key=WindowTargetIds,Values=350d44e6-28cc-44e2-951f-4b2c9EXAMPLE"
\ --task-arn"AWS-RunShellScript"
\ --service-role-arn"arn:aws:iam::111222333444:role/MaintenanceWindowsRole"
\ --window-id"mw-ab12cd34eEXAMPLE"
\ --task-type"RUN_COMMAND"
\ --task-parameters "{\"commands\":{\"Values\":[\"df\"]}}" \ --max-concurrency1
\ --max-errors1
\ --priority10
出力:
{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }
詳細については、AWS Systems Manager ユーザーガイドの「メンテナンスウィンドウ (AWS CLI) でタスクを登録する」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスRegisterTaskWithMaintenanceWindow
」の「」を参照してください。
-
- PowerShell
-
- のツール PowerShell
-
例 1: この例では、インスタンス ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。
$parameters = @{} $parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression $parameterValues.Values = @("Install") $parameters.Add("Operation", $parameterValues) Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
出力:
f34a2c47-ddfd-4c85-a88d-72366b69af1b
例 2: この例では、ターゲット ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。
$parameters = @{} $parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression $parameterValues.Values = @("Install") $parameters.Add("Operation", $parameterValues) register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
出力:
f34a2c47-ddfd-4c85-a88d-72366b69af1b
例 3: この例では、run コマンドドキュメント
AWS-RunPowerShellScript
のパラメータオブジェクトを作成し、ターゲット ID を使用して任意のメンテナンスウィンドウを持つタスクを作成します。返される出力はタスク ID です。$parameters = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new() $parameters.Add("commands",@("ipconfig","dir env:\computername")) $parameters.Add("executionTimeout",@(3600)) $props = @{ WindowId = "mw-0123e4cce56ff78ae" ServiceRoleArn = "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" MaxConcurrency = 1 MaxError = 1 TaskType = "RUN_COMMAND" TaskArn = "AWS-RunPowerShellScript" Target = @{Key="WindowTargetIds";Values="fe1234ea-56d7-890b-12f3-456b789bee0f"} Priority = 1 RunCommand_Parameter = $parameters Name = "set-via-cmdlet" } Register-SSMTaskWithMaintenanceWindow @props
出力:
f1e2ef34-5678-12e3-456a-12334c5c6cbe
例 4: この例では、 という名前のドキュメントを使用して AWS Systems Manager Automation タスクを登録します
Create-Snapshots
。$automationParameters = @{} $automationParameters.Add( "instanceId", @("{{ TARGET_ID }}") ) $automationParameters.Add( "AutomationAssumeRole", @("{arn:aws:iam::111111111111:role/AutomationRole}") ) $automationParameters.Add( "SnapshotTimeout", @("PT20M") ) Register-SSMTaskWithMaintenanceWindow -WindowId mw-123EXAMPLE456` -ServiceRoleArn "arn:aws:iam::123456789012:role/MW-Role"` -MaxConcurrency 1 -MaxError 1 -TaskArn "CreateVolumeSnapshots"` -Target @{ Key="WindowTargetIds";Values="4b5acdf4-946c-4355-bd68-4329a43a5fd1" }` -TaskType "AUTOMATION"` -Priority 4` -Automation_DocumentVersion '$DEFAULT' -Automation_Parameter $automationParameters -Name "Create-Snapshots"
-
API 詳細については、「 コマンドレットリファレンスRegisterTaskWithMaintenanceWindow」の「」を参照してください。 AWS Tools for PowerShell
-