Tentang register-task-with-maintenance opsi -windows - AWS Systems Manager

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Tentang register-task-with-maintenance opsi -windows

Perintah register-task-with-maintenance-window menyediakan beberapa pilihan untuk pengonfigurasian tugas sesuai dengan kebutuhan Anda. Beberapa di antaranya diperlukan, beberapa di antaranya opsional, dan beberapa di antaranya berlaku untuk satu jenis tugas jendela pemeliharaan saja.

Topik ini memberikan informasi tentang beberapa pilihan ini untuk membantu Anda menggunakan sampel di bagian tutorial ini. Untuk informasi lebih lanjut tentang semua pilihan perintah, lihat register-task-with-maintenance-window di Referensi Perintah AWS CLI .

Tentang pilihan --task-arn

Opsi --task-arn ini digunakan untuk menentukan sumber daya tempat tugas beroperasi. Nilai yang Anda tentukan tergantung dari jenis tugas yang Anda daftarkan, seperti yang dijelaskan di tabel berikut.

TaskArn format untuk tugas jendela pemeliharaan
Jenis tugas jendela pemeliharaan TaskArn nilai

RUN_COMMAND dan AUTOMATION

TaskArn adalah nama dokumen SSM atau Amazon Resource Name (ARN). Sebagai contoh:

AWS-RunBatchShellScript

-atau-

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

LAMBDA

TaskArn adalah nama fungsi atau ARN. Sebagai contoh:

SSMMy-Lambda-Function

-atau-

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

penting

Kebijakan IAM untuk Maintenance Windows mengharuskan Anda menambahkan awalan ke nama fungsi SSM Lambda (atau alias). Sebelum Anda melanjutkan untuk mendaftarkan jenis tugas ini, perbarui namanya AWS Lambda untuk disertakanSSM. Misalnya, jika nama fungsi Lambda Anda adalah MyLambdaFunction, ubah ke SSMMyLambdaFunction.

STEP_FUNCTIONS

TaskArn adalah ARN mesin tahapan. Sebagai contoh:

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

penting

Kebijakan IAM untuk windows pemeliharaan mengharuskan Anda mengawali nama mesin tahapan Step Functions dengan SSM. Sebelum Anda mendaftarkan jenis tugas ini, Anda harus memperbarui namanya AWS Step Functions untuk disertakanSSM. Misalnya, jika nama mesin tahapan Anda adalah MyStateMachine, ubah ke SSMMyStateMachine.
Tentang pilihan --service-role-arn

Peran AWS Systems Manager untuk diasumsikan saat menjalankan tugas jendela pemeliharaan.

Untuk informasi selengkapnya, lihat Menyiapkan Maintenance Windows

Tentang pilihan --task-invocation-parameters

Pilihan --task-invocation-parameters digunakan untuk menentukan parameter yang bersifat unik untuk masing-masing dari keempat jenis tugas. Parameter yang didukung untuk masing-masing dari keempat jenis tugas dijelaskan di tabel berikut.

catatan

Untuk informasi tentang penggunaan parameter semu di konten --task-invocation-parameters, seperti {{TARGET_ID}}, lihat Menggunakan parameter semu saat mendaftarkan tugas jendela pemeliharaan.

Pilihan parameter permintaan tugas untuk tugas jendela pemeliharaan

Jenis tugas jendela pemeliharaan Parameter yang tersedia Contoh

RUN_COMMAND

Komentar

DocumentHash

DocumentHashType

NotificationConfig

Keluaran3 BucketName

OutPutS3 KeyPrefix

Parameter

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": "DOC-EXAMPLE-BUCKET",
            "OutputS3KeyPrefix": "S3-PREFIX",
            "Parameters": {
                "commands": [
                    "Get-ChildItem$env: temp-Recurse|Remove-Item-Recurse-force"
                ]
            },
            "ServiceRoleArn": "arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole",
            "TimeoutSeconds": 3600
        }
    }

otomatisasi

DocumentVersion

Parameter

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

LAMBDA

ClientContext

Muatan

Pengualifikasi

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

STEP_FUNCTIONS

Input

Nama

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