Opsi parameter untuk perintah register-task-with-maintenance -windows - AWS Systems Manager

• AWS Systems ManagerChange Manager tidak lagi terbuka untuk pelanggan baru. Pelanggan yang sudah ada dapat terus menggunakan layanan ini seperti biasa. Untuk informasi selengkapnya, lihat perubahan AWS Systems ManagerChange Manager ketersediaan.

 

• AWS Systems Manager CloudWatch Dasbor tidak akan lagi tersedia setelah 30 April 2026. Pelanggan dapat terus menggunakan CloudWatch konsol Amazon untuk melihat, membuat, dan mengelola CloudWatch dasbor Amazon mereka, seperti yang mereka lakukan hari ini. Untuk informasi selengkapnya, lihat dokumentasi CloudWatch Dasbor Amazon.

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

Opsi parameter untuk perintah register-task-with-maintenance -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 .

Opsi perintah: --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 mendaftarkan jenis tugas ini, Anda harus memperbarui namanya di AWS Step Functions untuk menyertakan SSM. Misalnya, jika nama mesin tahapan Anda adalah MyStateMachine, ubah ke SSMMyStateMachine.
Opsi perintah: --service-role-arn

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

Untuk informasi selengkapnya, lihat Menyiapkan Maintenance Windows

Opsi perintah: --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

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