Parameteroptionen für den Befehl register-task-with-maintenance -windows - AWS Systems Manager

AWS Systems ManagerChange Managersteht neuen Kunden nicht mehr offen. Bestandskunden können den Service weiterhin wie gewohnt nutzen. Weitere Informationen finden Sie unter Änderung der AWS Systems ManagerChange Manager Verfügbarkeit.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Parameteroptionen für den Befehl register-task-with-maintenance -windows

Der Befehl register-task-with-maintenance-window bietet mehrere Optionen für die Konfiguration einer Aufgabe entsprechend Ihren Anforderungen. Einige sind erforderlich, einige sind optional und einige gelten nur für einen einzigen Wartungsfenster-Aufgabentyp.

In diesem Thema erhalten Sie Informationen zu einigen dieser Optionen, um Sie bei der Arbeit mit Beispielen in diesem Abschnitt des Tutorials zu unterstützen. Informationen über alle Befehlsoptionen finden Sie unter register-task-with-maintenance-window in der AWS CLI Command Reference.

Befehlsoption: --task-arn

Die Option --task-arn wird verwendet, um die Ressource anzugeben, die von der Aufgabe ausgeführt wird. Der von Ihnen angegebene Wert hängt wie in der folgenden Tabelle beschrieben, davon ab, welche Art von Aufgabe Sie registrieren möchten.

TaskArn Formate für Aufgaben im Wartungsfenster
Wartungsfenster-Aufgabentyp TaskArn Wert

RUN_COMMAND und AUTOMATION

TaskArn ist der SSM-Dokumentname oder der Amazon-Ressourcenname (ARN). Zum Beispiel:

AWS-RunBatchShellScript

–oder–

arn:aws:ssm:region:111122223333:document/My-Document.

LAMBDA

TaskArn ist der Funktionsname oder -ARN. Zum Beispiel:

SSMMy-Lambda-Function

–oder–

arn:aws:lambda:region:111122223333:function:SSMMyLambdaFunction.

Wichtig

Die IAM-Richtlinie für Maintenance Windows erfordert, dass Sie den Namen von Lambda-Funktionen (oder Aliasen) das Präfix SSM hinzufügen. Bevor Sie mit der Registrierung dieser Art von Aufgabe fortfahren, aktualisieren Sie ihren Namen so, dass er AWS Lambda einschließtSSM. Beispiel: Wenn Ihr Lambda-Funktionsname MyLambdaFunction lautet, ändern Sie ihn in SSMMyLambdaFunction.

STEP_FUNCTIONS

TaskArn ist der ARN des Zustandsautomaten. Zum Beispiel:

arn:aws:states:us-east-2:111122223333:stateMachine:SSMMyStateMachine.

Wichtig

Die IAM-Richtlinie für Wartungsfenster erfordert, dass Sie Step Functions-Zustandsautomaten-Namen das Präfix SSM geben. Bevor Sie diese Art der Aufgabe registrieren können, müssen Sie ihren Namen in AWS Step Functions so aktualisieren, dass in ihm SSM enthalten ist. Beispiel: Wenn der Name des Zustandsautomaten MyStateMachine lautet, ändern Sie ihn in SSMMyStateMachine.
Befehlsoption: --service-role-arn

Die Rolle AWS Systems Manager , die bei der Ausführung der Wartungsfensteraufgabe übernommen werden soll.

Weitere Informationen finden Sie unter Einrichten von Maintenance Windows.

Befehlsoption: --task-invocation-parameters

Die Option --task-invocation-parameters wird dazu verwendet, jene Parameter anzugeben, die nur für die vier Aufgabentypen gelten. Die unterstützten Parameter für jede der vier Arten von Aufgaben werden in der folgenden Tabelle beschrieben.

Anmerkung

Weitere Informationen über die Verwendung von Pseudoparametern in --task-invocation-parameters-Inhalten, z. B. {{TARGET_ID}}, finden Sie unter Verwendung von Pseudo-Parametern bei der Registrierung von Aufgaben im Wartungsfenster.

Aufgabenaufruf-Parameteroptionen für Wartungsfenster-Aufgaben

Wartungsfenster-Aufgabentyp Verfügbare Parameter Beispiel

RUN_COMMAND

Comment

DocumentHash

DocumentHashType

NotificationConfig

OutputS3BucketName

OutPutS3KeyPrefix

Parameters

ServiceRoleArn

TimeoutSeconds

 
"TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "My Run Command task comment",
            "DocumentHash": "6554ed3d--truncated--5EXAMPLE",
            "DocumentHashType": "Sha256",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:region:123456789012:my-sns-topic-name",
                "NotificationEvents": [
                    "FAILURE"
                ],
                "NotificationType": "Invocation"
            },
            "OutputS3BucketName": "amzn-s3-demo-bucket",
            "OutputS3KeyPrefix": "S3-PREFIX",
            "Parameters": {
                "commands": [
                    "Get-ChildItem$env: temp-Recurse|Remove-Item-Recurse-force"
                ]
            },
            "ServiceRoleArn": "arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole",
            "TimeoutSeconds": 3600
        }
    }

AUTOMATION

DocumentVersion

Parameters

 
"TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "3",
            "Parameters": {
                "instanceid": [
                    "{{TARGET_ID}}"
                ]
            }
        }
    }

LAMBDA

ClientContext

Payload

Qualifier

 
"TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"targetId\": \"{{TARGET_ID}}\", \"targetType\": \"{{TARGET_TYPE}}\" }",
            "Qualifier": "$LATEST"
        }
    }

STEP_FUNCTIONS

Input

Name

 
"TaskInvocationParameters": {
        "StepFunctions": {
            "Input": "{ \"targetId\": \"{{TARGET_ID}}\" }",
            "Name": "{{INVOCATION_ID}}"
        }
    }