aws:runCommand – Jalankan perintah pada instans terkelola

Menjalankan perintah yang ditentukan.

catatan

Otomatisasi hanya mendukung output dari satu AWS Systems Manager Run Command tindakan. Runbook dapat menyertakan beberapa Run Command tindakan, tetapi output didukung hanya untuk satu tindakan pada satu waktu.

Input

Tindakan ini mendukung sebagian besar parameter perintah kirim. Untuk informasi lebih lanjut, lihat SendCommand.

YAML

- name: checkMembership
  action: 'aws:runCommand'
  inputs:
    DocumentName: AWS-RunPowerShellScript
    InstanceIds:
      - '{{InstanceIds}}'
    Parameters:
      commands:
        - (Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain

JSON

{
    "name": "checkMembership",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-RunPowerShellScript",
        "InstanceIds": [
            "{{InstanceIds}}"
        ],
        "Parameters": {
            "commands": [
                "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
            ]
        }
    }
}

DocumentName

Jika dokumen tipe Command dimiliki oleh Anda atau AWS, tentukan nama dokumen. Jika Anda menggunakan dokumen yang dibagikan dengan Anda oleh Akun AWS yang berbeda, tentukan Amazon Resource Name (ARN) dokumen. Untuk informasi selengkapnya tentang penggunaan dokumen bersama, lihat Menggunakan dokumen SSM bersama.

Jenis: String

Diperlukan: Ya

InstanceIds

ID instans tempat Anda ingin menjalankan perintah. Anda dapat menentukan maksimum 50 ID.

Anda juga dapat menggunakan parameter semu {{RESOURCE_ID}} di tempat ID instans untuk menjalankan perintah pada semua instans dalam grup target. Untuk informasi selengkapnya tentang parameter semu, lihatMenggunakan parameter semu saat mendaftarkan tugas jendela pemeliharaan.

Alternatif lain adalah untuk mengirim perintah ke armada instans dengan menggunakan Targets parameter. Parameter Targets menerima tag Amazon Elastic Compute Cloud (Amazon EC2). Untuk informasi selengkapnya tentang cara menggunakan Targets parameter, lihat Menjalankan perintah saat skala.

Jenis: StringList

Wajib: Tidak (Jika Anda tidak menentukan InstanceIds atau menggunakan parameter {{RESOURCE_ID}} semu, maka Anda harus menentukan Targets parameternya.)

Target

Array kriteria pencarian yang menargetkan instans dengan menggunakan kombinasi Nilai Kunci yang Anda tentukan. Targets diperlukan jika Anda tidak memberikan satu ID instans atau lebih dalam panggilan. Untuk informasi selengkapnya tentang cara menggunakan Targets parameter, lihat Menjalankan perintah saat skala.

Jenis: MapList (Skema peta dalam daftar harus cocok dengan objek.) Untuk informasi lebih lanjut, lihat Target dalam AWS Systems Manager Referensi API.

Wajib: Tidak (Jika Anda tidak menentukanTargets, maka Anda harus menentukan InstanceIds atau menggunakan parameter {{RESOURCE_ID}} semu.)

Berikut adalah contohnya.

YAML

- name: checkMembership
  action: aws:runCommand
  inputs:
    DocumentName: AWS-RunPowerShellScript
    Targets:
      - Key: tag:Stage
        Values:
          - Gamma
          - Beta
      - Key: tag-key
        Values:
          - Suite
    Parameters:
      commands:
        - (Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain

JSON

{
    "name": "checkMembership",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-RunPowerShellScript",
        "Targets": [                   
            {
                "Key": "tag:Stage",
                "Values": [
                    "Gamma", "Beta"
                ]
            },
            {
                "Key": "tag:Application",
                "Values": [
                    "Suite"
                ]
            }
        ],
        "Parameters": {
            "commands": [
                "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
            ]
        }
    }
}

Parameter

Parameter yang diperlukan dan opsional yang ditentukan dalam dokumen.

Jenis: Peta

Wajib: Tidak

CloudWatchOutputConfig

Opsi konfigurasi untuk mengirim output perintah ke Amazon CloudWatch Logs. Untuk informasi selengkapnya tentang mengirim output perintah ke CloudWatch Log, lihatMengkonfigurasi CloudWatch Log Amazon untuk Run Command.

Jenis: StringMap (Skema peta harus cocok dengan objek. Untuk informasi selengkapnya, lihat CloudWatchOutputConfigdi Referensi AWS Systems Manager API).

Wajib: Tidak

Berikut adalah contohnya.

YAML

- name: checkMembership
  action: aws:runCommand
  inputs:
    DocumentName: AWS-RunPowerShellScript
    InstanceIds:
      - "{{InstanceIds}}"
    Parameters:
      commands:
        - "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
    CloudWatchOutputConfig:
      CloudWatchLogGroupName: CloudWatchGroupForSSMAutomationService
      CloudWatchOutputEnabled: true

JSON

{
    "name": "checkMembership",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-RunPowerShellScript",
        "InstanceIds": [
            "{{InstanceIds}}"
        ],
        "Parameters": {
            "commands": [
                "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
            ]
        },
        "CloudWatchOutputConfig" : { 
                "CloudWatchLogGroupName": "CloudWatchGroupForSSMAutomationService",
                "CloudWatchOutputEnabled": true
        }
    }
}

Komentar

Informasi yang ditetapkan pengguna tentang perintah.

Jenis: String

Wajib: Tidak

DocumentHash

Hash untuk dokumen.

Jenis: String

Wajib: Tidak

DocumentHashTipe

Jenis hash.

Jenis: String

Nilai yang valid: Sha256 | Sha1

Wajib: Tidak

NotificationConfig

Konfigurasi untuk mengirim notifikasi.

Wajib: Tidak

Keluaran3 BucketName

Nama bucket S3 untuk tanggapan output perintah.

Jenis: String

Wajib: Tidak

Keluaran3 KeyPrefix

Prefiks.

Jenis: String

Wajib: Tidak

ServiceRoleArn

ARN dari peran AWS Identity and Access Management (IAM).

Tipe: String

Wajib: Tidak

TimeoutSeconds

Jumlah waktu dalam hitungan detik untuk menunggu perintah dikirimkan ke AWS Systems Manager SSM Agent pada sebuah instance. Jika perintah tidak diterima oleh SSM Agent pada instance sebelum nilai yang ditentukan tercapai, maka status perintah berubah menjadiDelivery Timed Out.

Tipe: Integer

Wajib: Tidak

Nilai yang valid: 30-2592000

Output

CommandId

ID perintah.

Status

Status perintah.

ResponseCode

Kode respon perintah. Jika dokumen yang Anda jalankan memiliki lebih dari 1 langkah, nilai tidak dikembalikan untuk output ini.

Output

Output perintah. Jika Anda menargetkan tag atau beberapa instance dengan perintah Anda, tidak ada nilai output yang dikembalikan. Anda dapat menggunakan operasi GetCommandInvocation dan ListCommandInvocations API untuk mengambil output untuk instance individual.