将 RegisterTaskWithMaintenanceWindow
与 Amazon SDK 或 CLI 配合使用
以下代码示例演示如何使用 RegisterTaskWithMaintenanceWindow
。
- CLI
-
- Amazon CLI
-
示例 1:向维护时段注册 Automation 任务
以下
register-task-with-maintenance-window
示例向针对实例的维护时段注册 Automation 任务。aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649EXAMPLE" \ --targets Key=InstanceIds,Values=i-1234520122EXAMPLE \ --task-arn AWS-RestartEC2Instance \ --service-role-arn arn:aws:iam::111222333444:role/SSM --task-type AUTOMATION \ --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$LATEST\",\"Parameters\":{\"InstanceId\":[\"{{RESOURCE_ID}}\"]}}}" \ --priority 0 \ --max-concurrency 1 \ --max-errors 1 \ --name "AutomationExample" \ --description "Restarting EC2 Instance for maintenance"
输出:
{ "WindowTaskId":"11144444-5555-6666-7777-88888888" }
有关更多信息,请参阅《Amazon Systems Manager 用户指南》中的向维护时段注册任务(Amazon CLI)。
示例 2:向维护时段注册 Lambda 任务
以下
register-task-with-maintenance-window
示例向针对实例的维护时段注册 Lambda 任务。aws ssm register-task-with-maintenance-window \ --window-id "mw-082dcd7649dee04e4" \ --targets Key=InstanceIds,Values=i-12344d305eEXAMPLE \ --task-arn arn:aws:lambda:us-east-1:111222333444:function:SSMTestLAMBDA \ --service-role-arn arn:aws:iam::111222333444:role/SSM \ --task-type LAMBDA \ --task-invocation-parameters '{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier":"$LATEST"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Lambda_Example" \ --description "My Lambda Example"
输出:
{ "WindowTaskId":"22244444-5555-6666-7777-88888888" }
有关更多信息,请参阅《Amazon Systems Manager 用户指南》中的向维护时段注册任务(Amazon 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\/110351\/1\/EZOut.zip\"],\"workingDirectory\":[\"\\\\\"]},\"TimeoutSeconds\":600}}" \ --max-concurrency 1 \ --max-errors 1 \ --priority 10
输出:
{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }
有关更多信息,请参阅《Amazon Systems Manager 用户指南》中的向维护时段注册任务(Amazon CLI)。
示例 4:向维护时段注册 Step Functions 任务
以下
register-task-with-maintenance-window
示例向针对实例的维护时段注册 Step Functions 任务。aws ssm register-task-with-maintenance-window \ --window-id "mw-1234d787d6EXAMPLE" \ --targets Key=WindowTargetIds,Values=12347414-69c3-49f8-95b8-ed2dcEXAMPLE \ --task-arn arn:aws:states:us-east-1:111222333444:stateMachine:SSMTestStateMachine \ --service-role-arn arn:aws:iam::111222333444:role/MaintenanceWindows \ --task-type STEP_FUNCTIONS \ --task-invocation-parameters '{"StepFunctions":{"Input":"{\"InstanceId\":\"{{RESOURCE_ID}}\"}"}}' \ --priority 0 \ --max-concurrency 10 \ --max-errors 5 \ --name "Step_Functions_Example" \ --description "My Step Functions Example"
输出:
{ "WindowTaskId":"44444444-5555-6666-7777-88888888" }
有关更多信息,请参阅《Amazon Systems Manager 用户指南》中的向维护时段注册任务(Amazon 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-concurrency 1 \ --max-errors 1 \ --priority 10
输出:
{ "WindowTaskId":"33344444-5555-6666-7777-88888888" }
有关更多信息,请参阅《Amazon Systems Manager 用户指南》中的向维护时段注册任务(Amazon CLI)。
-
有关 API 详细信息,请参阅《Amazon CLI Command Reference》中的 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:此示例为运行命令文档
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:此示例使用名为
Create-Snapshots
的文档注册 Amazon Systems Manager Automation 任务。$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 详细信息,请参阅《Amazon Tools for PowerShell Cmdlet Reference》中的 RegisterTaskWithMaintenanceWindow。
-
有关 Amazon SDK 开发人员指南和代码示例的完整列表,请参阅 将 Systems Manager 与 Amazon SDK 配合使用。本主题还包括有关入门的信息以及有关先前的 SDK 版本的详细信息。