Opciones de parámetros para el comando register-task-with-maintenance-windows - AWS Systems Manager

AWS Systems Manager Change Manager ya no está abierto a nuevos clientes. Los clientes existentes pueden seguir utilizando el servicio con normalidad. Para obtener más información, consulte Cambio en la disponibilidad de Change Manager de AWS Systems Manager.

Opciones de parámetros para el comando register-task-with-maintenance-windows

El comando register-task-with-maintenance-window proporciona varias opciones para configurar una tarea en función de sus necesidades. Algunas son obligatorias, otras opcionales y otras solo se aplican a un único tipo de tarea de ventana de mantenimiento.

En este tema se proporciona información sobre algunas de estas opciones para ayudarlo a trabajar con los ejemplos de esta sección del tutorial. Para obtener información acerca de todas las opciones de comandos, consulte register-task-with-maintenance-window en la Referencia de comando de la AWS CLI.

Opción de comando: --task-arn

La opción --task-arn se usa para especificar el recurso en el que opera la tarea. El valor que se especifica depende del tipo de tarea que se registra, como se describe en la siguiente tabla.

Formatos de TaskArn para tareas del periodo de mantenimiento
Tipo de tarea de la ventana de mantenimiento Valor TaskArn

RUN_COMMAND y AUTOMATION

TaskArn es el nombre del documento de SSM o el nombre de recurso de Amazon (ARN). Por ejemplo:

AWS-RunBatchShellScript

-o bien-

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

LAMBDA

TaskArn es el nombre de la función o ARN. Por ejemplo:

SSMMy-Lambda-Function

-o bien-

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

importante

La política de IAM para Maintenance Windows requiere que se agregue el prefijo SSM a los nombres de la función (o alias) de Lambda. Antes de continuar con el registro de este tipo de tareas, actualice el nombre en AWS Lambda para incluir SSM. Por ejemplo, si el nombre de la función de Lambda es MyLambdaFunction, cámbielo a SSMMyLambdaFunction.

STEP_FUNCTIONS

TaskArn es el ARN de la máquina de estado. Por ejemplo:

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

importante

La política de IAM para periodos de mantenimiento requiere que se agregue el prefijo SSM a los nombres de máquina de estado de Step Functions. Antes de registrar este tipo de tarea, debe actualizar su nombre en AWS Step Functions para que incluya SSM. Por ejemplo, si el nombre de la máquina de estado es MyStateMachine, cámbielo a SSMMyStateMachine.
Opción de comando: --service-role-arn

El rol que AWS Systems Manager debe asumir cuando se ejecuta la tarea del periodo de mantenimiento.

Para obtener más información, consulte Configuración de Maintenance Windows

Opción de comando: --task-invocation-parameters

La opción --task-invocation-parameters se utiliza para especificar los parámetros que son exclusivos de cada uno de los cuatro tipos de tarea. Los parámetros admitidos para cada uno de estos cuatro tipos se describen en la tabla siguiente.

nota

Para obtener información acerca de cómo utilizar los pseudoparámetros en contenido --task-invocation-parameters, como {{TARGET_ID}}, consulte Utilización de pseudoparámetros en el registro de las tareas del periodo de mantenimiento.

Opciones de los parámetros de invocación de tareas de periodos de mantenimiento

Tipo de tarea de la ventana de mantenimiento Parámetros disponibles Ejemplo

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