Menggunakan parameter semu saat mendaftarkan tugas jendela pemeliharaan

Ketika Anda mendaftarkan tugas diMaintenance Windows, kemampuan AWS Systems Manager, Anda menentukan parameter yang unik untuk masing-masing dari empat jenis tugas. (Dalam perintah CLI, ini disediakan menggunakan --task-invocation-parameters opsi.)

Anda juga dapat mereferensikan nilai tertentu menggunakan sintaks parameter semu, seperti {{RESOURCE_ID}}, {{TARGET_TYPE}}, dan {{WINDOW_TARGET_ID}}. Ketika tugas jendela pemeliharaan berjalan, ia meneruskan nilai yang benar dan bukan placeholder parameter semu. Daftar lengkap parameter semu yang dapat Anda gunakan disediakan nanti dalam topik ini diParameter semu yang didukung.

penting

Untuk jenis target RESOURCE_GROUP, tergantung dari format ID yang diperlukan untuk tugas, Anda dapat memilih antara penggunaan {{TARGET_ID}} dan {{RESOURCE_ID}}untuk mereferensikan sumber daya saat tugas berjalan. {{TARGET_ID}}menampilkan ARN lengkap dari sumber daya. {{RESOURCE_ID}} menampilkan hanya nama atau ID dari sumber daya yang lebih singkat, seperti yang ditunjukkan dalam contoh ini.

• Format {{TARGET_ID}}: arn:aws:ec2:us-east-1:123456789012:instance/i-02573cafcfEXAMPLE

• Format {{RESOURCE_ID}}: i-02573cafcfEXAMPLE

Untuk jenis target INSTANCE, baik parameter {{TARGET_ID}} maupun {{RESOURCE_ID}} menghasilkan ID instans saja. Untuk informasi selengkapnya, lihat Parameter semu yang didukung.

{{TARGET_ID}}dan {{RESOURCE_ID}} dapat digunakan untuk meneruskan ID AWS sumber daya hanya ke tugas Otomasi, Lambda, dan Step Functions. Kedua parameter semu ini tidak dapat digunakan dengan Run Command tugas.

Contoh parameter semu

Misalkan payload Anda untuk suatu AWS Lambda tugas perlu mereferensikan instance dengan ID-nya.

Baik Anda menggunakan target jendela RESOURCE_GROUP pemeliharaan INSTANCE atau pemeliharaan, ini dapat dicapai dengan menggunakan parameter {{RESOURCE_ID}} semu. Sebagai contoh:

"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction",
    "TaskType": "LAMBDA",
    "TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"instanceId\": \"{{RESOURCE_ID}}\" }",
            "Qualifier": "$LATEST"
        }
    }

Jika tugas Lambda Anda dimaksudkan untuk dijalankan terhadap jenis target yang didukung lainnya selain instans Amazon Elastic Compute Cloud (Amazon EC2), seperti tabel Amazon DynamoDB, sintaks yang sama dapat digunakan, dan {{RESOURCE_ID}} menghasilkan nama tabel saja. Akan tetapi, jika Anda memerlukan ARN lengkap dari tabel, gunakan {{TARGET_ID}}, seperti yang ditunjukkan dalam contoh berikut.

"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction",
    "TaskType": "LAMBDA",
    "TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"tableArn\": \"{{TARGET_ID}}\" }",
            "Qualifier": "$LATEST"
        }
    }

Sintaks yang sama berfungsi untuk penargetan instans atau jenis sumber daya lainnya. Ketika beberapa jenis sumber daya telah ditambahkan ke grup sumber daya, tugas berjalan terhadap masing-masing sumber daya yang sesuai.

penting

Tidak semua jenis sumber daya yang mungkin disertakan di grup sumber daya menghasilkan nilai untuk parameter {{RESOURCE_ID}}. Untuk daftar jenis sumber daya yang didukung, lihat Parameter semu yang didukung.

Sebagai contoh lain, untuk menjalankan tugas Otomatisasi yang menghentikan instans EC2, Anda menentukan dokumen Systems Manager AWS-StopEC2Instance (dokumen SSM) sebagai nilai TaskArn dan menggunakan parameter semu {{RESOURCE_ID}}:

"TaskArn": "AWS-StopEC2Instance",
    "TaskType": "AUTOMATION"
    "TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "1",
            "Parameters": {
                "instanceId": [
                    "{{RESOURCE_ID}}"
                ]
            }
        }
    }

Untuk menjalankan tugas Otomatisasi yang menyalin snapshot volume Amazon Elastic Block Store (Amazon EBS), Anda menentukan dokumen SSM AWS-CopySnapshot sebagai nilai TaskArn dan menggunakan parameter semu {{RESOURCE_ID}}.

"TaskArn": "AWS-CopySnapshot",
    "TaskType": "AUTOMATION"
    "TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "1",
            "Parameters": {
                "SourceRegion": "us-east-2",
                "targetType":"RESOURCE_GROUP",
                "SnapshotId": [
                    "{{RESOURCE_ID}}"
                ]
            }
        }
    }

Parameter semu yang didukung

Daftar berikut ini menjelaskan parameter semu yang dapat Anda tentukan menggunakan sintaks {{PSEUDO_PARAMETER}} di pilihan --task-invocation-parameters.

• WINDOW_ID: ID dari jendela pemeliharaan target.

• WINDOW_TASK_ID: ID tugas jendela yang sedang berjalan.

• WINDOW_TARGET_ID: ID dari target jendela yang menyertakan target (ID target).

• WINDOW_EXECUTION_ID: ID dari eksekusi jendela saat ini.

• TASK_EXECUTION_ID: ID dari eksekusi tugas saat ini.

• INVOCATION_ID: ID dari permintaan saat ini.

• TARGET_TYPE: Jenis target. Jenis yang didukung termasuk RESOURCE_GROUP dan INSTANCE.

• TARGET_ID:

  Jika jenis target yang Anda tentukan adalahINSTANCE, parameter TARGET_ID semu diganti dengan ID instance. Misalnya, i-078a280217EXAMPLE.

  Jika jenis target yang Anda tentukan adalahRESOURCE_GROUP, nilai yang direferensikan untuk eksekusi tugas adalah ARN penuh dari sumber daya. Misalnya: arn:aws:ec2:us-east-1:123456789012:instance/i-078a280217EXAMPLE. Tabel berikut menyediakan sampel nilai TARGET_ID untuk jenis sumber daya tertentu dalam grup sumber daya.

  catatan

  TARGET_IDtidak didukung untuk Run Command tugas.

  Jenis sumber daya	Contoh TARGET_ID
  AWS::CloudWatch::Alarm	arn:aws:cloudwatch:us-east-1:123456789012:alarm:MyCloudWatchAlarmi-078a280217EXAMPLE
  AWS::EC2::Instance	arn:aws:ec2:us-east-1:123456789012:instance/i-078a280217EXAMPLE
  AWS::EC2::Image	arn:aws:ec2:us-east-1:123456789012:image/ami-02250b3732EXAMPLE
  AWS::EC2::SecurityGroup	arn:aws:ec2:us-east-1:123456789012:security-group/sg-cEXAMPLE
  AWS::EC2::Snapshot	arn:aws:ec2:us-east-1:123456789012:snapshot/snap-03866bf003EXAMPLE
  AWS::EC2::Volume	arn:aws:ec2:us-east-1:123456789012:volume/vol-0912e04d78EXAMPLE
  AWS::DynamoDB::Table	arn:aws:dynamodb:us-east-1:123456789012:table/MyTable
  AWS::RDS::DBCluster	arn:aws:rds:us-east-2:123456789012:cluster:My-Cluster
  AWS::RDS::DBInstance	arn:aws:rds:us-east-1:123456789012:db:My-SQL-Instance
  AWS::S3::Bucket	arn:aws:s3::: DOC-EXAMPLE-BUCKET
  AWS::SSM::ManagedInstance	arn:aws:ssm:us-east-1:123456789012:managed-instance/mi-0feadcf2d9EXAMPLE

• RESOURCE_ID: ID singkat dari jenis sumber daya yang terkandung dalam grup sumber daya. Tabel berikut menyediakan sampel nilai RESOURCE_ID untuk jenis sumber daya tertentu dalam grup sumber daya.

  catatan

  RESOURCE_IDtidak didukung untuk Run Command tugas.

  Jenis sumber daya	Contoh RESOURCE_ID
  AWS::CloudWatch::Alarm	MyCloudWatchAlarm
  AWS::EC2::Instance	i-078a280217EXAMPLE
  AWS::EC2::Image	ami-02250b3732EXAMPLE
  AWS::EC2::SecurityGroup	sg-cEXAMPLE
  AWS::EC2::Snapshot	snap-03866bf003EXAMPLE
  AWS::EC2::Volume	vol-0912e04d78EXAMPLE
  AWS::DynamoDB::Table	MyTable
  AWS::RDS::DBCluster	My-Cluster
  AWS::RDS::DBInstance	My-SQL-Instance
  AWS::S3::Bucket	DOC-EXAMPLE-BUCKET
  AWS::SSM::ManagedInstance	mi-0feadcf2d9EXAMPLE

  catatan

  Jika grup AWS sumber daya yang Anda tentukan menyertakan tipe sumber daya yang tidak menghasilkan RESOURCE_ID nilai, dan tidak tercantum dalam tabel sebelumnya, maka RESOURCE_ID parameter tidak diisi. Permintaan eksekusi masih akan terjadi untuk sumber daya tersebut. Dalam hal ini, gunakan parameter semu TARGET_ID saja, yang akan diganti dengan ARN lengkap dari sumber daya.