Opzioni dei parametri per il comando register-task-with-maintenance -windows - AWS Systems Manager

AWS Systems ManagerChange Managernon è più aperto a nuovi clienti. I clienti esistenti possono continuare a utilizzare il servizio normalmente. Per ulteriori informazioni, consulta AWS Systems ManagerChange Managerla pagina Modifica della disponibilità.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Opzioni dei parametri per il comando register-task-with-maintenance -windows

Il comando register-task-with-maintenance-window dispone di diverse opzioni per la configurazione di un task in base a esigenze specifiche. Alcune opzioni sono obbligatorie, altre sono facoltative, mentre alcune di esse sono valide solo per un tipo specifico di task della finestra di manutenzione.

Questo argomento fornisce informazioni su alcune di queste opzioni a supporto delle procedure di utilizzo degli esempi disponibili in questa sezione del tutorial. Per informazioni su altre opzioni di comando, consulta register-task-with-maintenance-window nelle Informazioni di riferimento sui comandi AWS CLI .

Opzione di comando: --task-arn

L'opzione --task-arn consente di specificare la risorsa utilizzata dal task durante l'operazione. Il valore che è possibile specificare dipende dal tipo di task che si sta registrando, come descritto nella seguente tabella.

TaskArn formati per le attività delle finestre di manutenzione
Tipo di task della finestra di manutenzione TaskArn valore

RUN_COMMAND e AUTOMATION

TaskArn è il nome del documento SSM o l'Amazon Resource Name (ARN). Ad esempio:

AWS-RunBatchShellScript

oppure

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

LAMBDA

TaskArn è l'ARN o il nome della funzione. Ad esempio:

SSMMy-Lambda-Function

oppure

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

Importante

La policy IAM per Maintenance Windows prevede che il nome (o l'alias) della funzione Lambda sia associato al prefisso SSM. Prima di procedere alla registrazione di questo tipo di attività, aggiornane il nome in AWS Lambda includiSSM. Ad esempio, se il nome della funzione Lambda è MyLambdaFunction, modifica tale nome in SSMMyLambdaFunction.

STEP_FUNCTIONS

TaskArn è l'ARN della macchina a stati. Ad esempio:

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

Importante

La policy IAM per le finestre di manutenzione prevede che i nomi delle macchine a stati Step Functions siano associati al prefisso SSM. Prima di registrare questo tipo di task, è necessario aggiornare il relativo nome in AWS Step Functions in modo da includere SSM. Ad esempio, se il nome della macchina a stati è MyStateMachine, modifica tale nome in SSMMyStateMachine.
Opzione di comando: --service-role-arn

Il ruolo AWS Systems Manager da assumere durante l'esecuzione dell'operazione della finestra di manutenzione.

Per ulteriori informazioni, consulta Configurazione di Maintenance Windows

Opzione di comando: --task-invocation-parameters

L'opzione --task-invocation-parameters viene utilizzata per specificare i parametri univoci per ciascuno dei quattro tipi di task. I parametri supportati per ciascuno dei quattro tipi di task sono descritti nella tabella riportata di seguito.

Nota

Per informazioni sull'utilizzo degli pseudoparametri nel contenuto --task-invocation-parameters, ad esempio {{TARGET_ID}}, consulta Utilizzo degli pseudo parametri durante la registrazione delle attività della finestra di manutenzione.

Opzioni dei parametri di invocazione dei task per i task della finestra di manutenzione

Tipo di task della finestra di manutenzione Parametri disponibili Esempio

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