• La AWS Systems Manager CloudWatch dashboard non sarà più disponibile dopo il 30 aprile 2026. I clienti possono continuare a utilizzare la CloudWatch console Amazon per visualizzare, creare e gestire le proprie CloudWatch dashboard Amazon, proprio come fanno oggi. Per ulteriori informazioni, consulta la documentazione di Amazon CloudWatch Dashboard.

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à.

Esempi: registrazione delle operazioni con una finestra di manutenzione

È possibile registrare un'attività inRun Command, con una finestra di manutenzione, utilizzando il pulsante AWS Command Line Interface (AWS CLI), come illustrato in Registra attività con la finestra di manutenzione. È inoltre possibile registrare le attività per i flussi di lavoro, AWS Lambda le funzioni e le AWS Step Functions attività di Systems Manager Automation, come illustrato più avanti in questo argomento.

Nota

Specifica uno o più target per le attività di tipo Run Command della finestra di manutenzione. A seconda dell'attività, gli obiettivi sono opzionali per altri tipi di attività della finestra di manutenzione (Automazione e AWS Step Functions). AWS Lambda Per ulteriori informazioni sull'esecuzione di attività che non specificano destinazioni, consulta Registrazione delle attività della finestra di manutenzione senza destinazioni.

In questo argomento, forniamo esempi di utilizzo del comando AWS Command Line Interface (AWS CLI) register-task-with-maintenance-window per registrare ciascuno dei quattro tipi di attività supportati con una finestra di manutenzione. Gli esempi sono solo a titolo dimostrativo, ma è possibile modificarli per creare comandi di registrazione di task funzionanti.

Utilizzo dell'opzione --cli-input-json

Per ottimizzare la gestione delle opzioni relative ai task, è possibile utilizzare l'opzione di comando --cli-input-json, con i valori delle opzioni inclusi in un file JSON.

Per utilizzare il contenuto del file JSON di esempio disponibile negli esempi, eseguire la procedura seguente nel computer locale:

Creare un file assegnandogli, ad esempio, il nome MyRunCommandTask.json, MyAutomationTask.json oppure il nome desiderato.
Copiare il contenuto dell'esempio JSON nel file.
Modificare il contenuto del file per la registrazione del task, quindi salvare il file.

Nella stessa directory in cui è stato salvato il file, eseguire il comando seguente. Sostituisci il nome del file con. MyFile.json

Pseudo parametri nelle attività della finestra di manutenzione

In alcuni esempi vengono utilizzati gli pseudoparametri come metodo per passare le informazioni sugli ID ai task. Ad esempio, {{TARGET_ID}} e {{RESOURCE_ID}} sono utilizzabili per passare gli ID delle risorse AWS alle operazioni di Automazione, Lambda e Step Functions. Per ulteriori informazioni sugli pseudoparametri nel parametro --task-invocation-parameters, consulta Utilizzo degli pseudo parametri durante la registrazione delle attività della finestra di manutenzione.

Ulteriori informazioni

Opzioni dei parametri per il comando register-task-with-maintenance-windows.
register-task-with-maintenance-window in Riferimento ai comandi AWS CLI
RegisterTaskWithMaintenanceWindow nella Documentazione di riferimento API di AWS Systems Manager

Esempi di registrazione dei task

Le sezioni seguenti forniscono un AWS CLI comando di esempio per la registrazione di un tipo di attività supportato e un esempio JSON che può essere utilizzato con l'opzione. --cli-input-json

I seguenti esempi illustrano come registrare i task Run Command di Systems Manager con una finestra di manutenzione utilizzando l' AWS CLI.

Contenuto JSON da utilizzare con l'opzione di file --cli-input-json:


{
    "TaskType": "RUN_COMMAND",
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Description": "My Run Command task to update SSM Agent on an instance",
    "MaxConcurrency": "1",
    "MaxErrors": "1",
    "Name": "My-Run-Command-Task",
    "Priority": 10,
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE"
            ]
        }
    ],
    "TaskArn": "AWS-UpdateSSMAgent",
    "TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "A TaskInvocationParameters test comment",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:region:123456789012:my-sns-topic-name",
                "NotificationEvents": [
                    "All"
                ],
                "NotificationType": "Invocation"
            },
            "OutputS3BucketName": "amzn-s3-demo-bucket",
            "OutputS3KeyPrefix": "S3-PREFIX",
            "TimeoutSeconds": 3600
        }
    }
}

I seguenti esempi illustrano come registrare i task di automazione di Systems Manager con una finestra di manutenzione utilizzando l' AWS CLI:

AWS CLI comando:

Contenuto JSON da utilizzare con l'opzione di file --cli-input-json:


{
    "WindowId": "mw-0c50858d01EXAMPLE",
        "TaskArn": "AWS-PatchInstanceWithRollback",
    "TaskType": "AUTOMATION","TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "1",
            "Parameters": {
                "instanceId": [
                    "{{RESOURCE_ID}}"
                ]
            }
        }
    }
}

I seguenti esempi illustrano come registrare le operazioni delle funzioni Lambda con una finestra di manutenzione utilizzando la AWS CLI.

Importante

Le funzioni Lambda devono trovarsi nella Account AWS stessa finestra di manutenzione quando si utilizza il ruolo collegato al servizio (). AWSServiceRoleForAmazonSSM Cross-account L'invocazione Lambda non è supportata con il ruolo collegato al servizio. Se devi richiamare una funzione Lambda in un account diverso, specifica un ruolo di servizio personalizzato utilizzando il --service-role-arn parametro con autorizzazioni esplicitamente limitate all'account di destinazione e aggiungi una policy basata sulle risorse sulla funzione Lambda di destinazione che concede l'accesso di invocazione al tuo ruolo personalizzato.

Per questi esempi, l'utente che ha creato la funzione Lambda ha denominato tale funzione SSMrestart-my-instances e ha creato due parametri denominati instanceId e targetType.

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à, aggiorna il suo nome inserendo. AWS Lambda SSM Ad esempio, se il nome della funzione Lambda è MyLambdaFunction, modificalo in SSMMyLambdaFunction.

AWS CLI comando:

Linux & macOS

Importante

Se stai usando la versione 2 di AWS CLI, devi includere l'opzione --cli-binary-format raw-in-base64-out nel comando seguente se il payload Lambda non è codificato in base64. L'opzione cli_binary_format è disponibile solo nella versione 2. Per informazioni su questa e altre impostazioni dei file, consulta Impostazioni dei AWS CLI config config file supportate nella Guida per l'utente. AWS Command Line Interface


aws ssm register-task-with-maintenance-window \
    --window-id "mw-0c50858d01EXAMPLE" \
    --targets "Key=WindowTargetIds,Values=e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE" \
    --priority 2 --max-concurrency 10 --max-errors 5 --name "My-Lambda-Example" \
    --description "A description for my LAMBDA example task" --task-type "LAMBDA" \
    --task-arn "arn:aws:lambda:region:123456789012:function:serverlessrepo-SSMrestart-my-instances-C4JF9EXAMPLE" \
    --task-invocation-parameters '{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier": "$LATEST"}}'

PowerShell

Importante

Se si utilizza la versione 2 di AWS CLI, è necessario includere l'opzione --cli-binary-format raw-in-base64-out nel comando seguente se il payload Lambda non è codificato in base64. L'opzione cli_binary_format è disponibile solo nella versione 2. Per informazioni su questa e altre impostazioni dei file, consulta Impostazioni dei AWS CLI config config file supportate nella Guida per l'utente. AWS Command Line Interface


aws ssm register-task-with-maintenance-window `
    --window-id "mw-0c50858d01EXAMPLE" `
    --targets "Key=WindowTargetIds,Values=e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE" `
    --priority 2 --max-concurrency 10 --max-errors 5 --name "My-Lambda-Example" `
    --description "A description for my LAMBDA example task" --task-type "LAMBDA" `
    --task-arn "arn:aws:lambda:region:123456789012:function:serverlessrepo-SSMrestart-my-instances-C4JF9EXAMPLE" `
    --task-invocation-parameters '{\"Lambda\":{\"Payload\":\"{\\\"InstanceId\\\":\\\"{{RESOURCE_ID}}\\\",\\\"targetType\\\":\\\"{{TARGET_TYPE}}\\\"}\",\"Qualifier\": \"$LATEST\"}}'

Contenuto JSON da utilizzare con l'opzione di file --cli-input-json:


{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE"
            ]
        }
    ],
    "TaskArn": "SSM_RestartMyInstances",
    "TaskType": "LAMBDA",
    "MaxConcurrency": "10",
    "MaxErrors": "10",
    "TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"instanceId\": \"{{RESOURCE_ID}}\", \"targetType\": \"{{TARGET_TYPE}}\" }",
            "Qualifier": "$LATEST"
        }
    },
    "Name": "My-Lambda-Task",
    "Description": "A description for my LAMBDA task",
    "Priority": 5
}

I seguenti esempi illustrano come registrare i task delle macchine a stati Step Functions con una finestra di manutenzione utilizzando l' AWS CLI.

Importante

Le macchine a stati di Step Functions devono trovarsi nella Account AWS stessa finestra di manutenzione. Cross-account L'invocazione di Step Functions non è supportata indipendentemente dal fatto che si utilizzi il ruolo collegato al servizio o un ruolo di servizio personalizzato.

Nota

Le attività della finestra di manutenzione supportano solo i flussi di lavoro delle macchine a stati standard di Step Functions. Non supportano i flussi di lavoro delle macchine a stati express. Per informazioni sui tipi di flusso di lavoro delle macchine a stati, consulta Standard vs. Express Workflows (Differenze flussi di lavoro standard ed express) nella Guida per gli sviluppatori di AWS Step Functions .

Per questi esempi, l'utente che ha creato le macchine a stati Step Functions ha creato una macchina a stati denominata SSMMyStateMachine con un parametro denominato instanceId.

Importante

La policy AWS Identity and Access Management (IAM) per Maintenance Windows richiede di anteporre ai nomi delle macchine di stato di Step Functions il prefisso. SSM Prima di procedere alla registrazione di 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.

AWS CLI comando:

Contenuto JSON da utilizzare con l'opzione di file --cli-input-json:


{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE"
            ]
        }
    ],
    "TaskArn": "SSM_MyStateMachine",
    "TaskType": "STEP_FUNCTIONS",
    "MaxConcurrency": "10",
    "MaxErrors": "10",
    "TaskInvocationParameters": {
        "StepFunctions": {
            "Input": "{ \"instanceId\": \"{{TARGET_ID}}\" }",
            "Name": "{{INVOCATION_ID}}"
        }
    },
    "Name": "My-Step-Functions-Task",
    "Description": "A description for my Step Functions task",
    "Priority": 5
}

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Fase 3: Registrare un'attività nella finestra di manutenzione utilizzando AWS CLI

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