Options de paramètres pour la commande register-task-with-maintenance -windows - AWS Systems Manager

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Options de paramètres pour la commande register-task-with-maintenance -windows

La commande register-task-with-maintenance-window fournit plusieurs options pour configurer une tâche en fonction de vos besoins. Certaines sont requises, certaines sont facultatives et d'autres s'appliquent à un seul type de tâche de fenêtre de maintenance.

Cette rubrique fournit des informations sur certaines de ces options pour vous aider à utiliser les exemples de cette section du didacticiel. Pour plus d'informations sur les autres options de commande, consultez register-task-with-maintenance-window dans la Référence Command AWS CLI .

Option de commande : --task-arn

L'option --task-arn est utilisée pour spécifier la ressource sur laquelle la tâche opère. La valeur que vous spécifiez dépend du type de tâche que vous enregistrez, comme décrit dans le tableau suivant.

TaskArn formats pour les tâches de la fenêtre de maintenance
Type de tâche de fenêtre de maintenance TaskArn valeur

RUN_COMMAND et AUTOMATION

TaskArn correspond au nom ou à l'Amazon Resource Name (ARN) du nom du document SSM. Par exemple :

AWS-RunBatchShellScript

-ou-

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

LAMBDA

TaskArn est le nom de fonction ou l'ARN. Par exemple :

SSMMy-Lambda-Function

-ou-

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

Important

La politique IAM pour Maintenance Windows nécessite que vous ajoutiez le préfixe SSM aux noms des fonctions Lambda (ou alias). Avant de procéder à l'enregistrement de ce type de tâche, mettez à jour son nom AWS Lambda pour inclureSSM. Par exemple, si votre nom de fonction Lambda est MyLambdaFunction, remplacez-le par SSMMyLambdaFunction.

STEP_FUNCTIONS

TaskArn est l'ARN de la machine d'état. Par exemple :

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

Important

La politique IAM pour les fenêtres de maintenance exige que vous donniez un préfixe aux noms de machines d'état Step Functions avec SSM. Avant d'enregistrer ce type de tâche, vous devez mettre à jour son nom dans AWS Step Functions pour inclure SSM. Par exemple, si le nom de votre machine d'état est MyStateMachine, remplacez-le par SSMMyStateMachine.
Option de commande : --service-role-arn

Le rôle AWS Systems Manager à assumer lors de l'exécution de la tâche de fenêtre de maintenance.

Pour plus d’informations, consultez Configuration Maintenance Windows.

Option de commande : --task-invocation-parameters

L'option --task-invocation-parameters permet de spécifier les paramètres qui sont spécifiques à chacun des quatre types de tâches. Les paramètres pris en charge pour chacun des quatre types de tâches sont décrits dans le tableau suivant.

Note

Pour plus d'informations sur l'utilisation des pseudo-paramètres dans le contenu --task-invocation-parameters, comme {{TARGET_ID}}, consultez Utiliser des pseudo paramètres lors de l’enregistrement des tâches de la fenêtre de maintenance.

Options de paramètres d’invocation de tâches pour les tâches de fenêtres de maintenance

Type de tâche de fenêtre de maintenance Paramètres disponibles exemple

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}}"
        }
    }