aws:runCommand – Jalankan perintah pada instans terkelola - AWS Systems Manager

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

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 dokumen lain Akun AWS, tentukan Amazon Resource Name (ARN) dokumen. Untuk informasi selengkapnya tentang penggunaan dokumen bersama, lihat Menggunakan SSM dokumen bersama.

Jenis: String

Diperlukan: Ya

InstanceIds

Contoh di IDs mana Anda ingin perintah dijalankan. Anda dapat menentukan maksimal 50IDs.

Anda juga dapat menggunakan parameter {{RESOURCE_ID}} semu sebagai pengganti instance IDs untuk menjalankan perintah pada semua instance 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. TargetsParameter menerima tag Amazon Elastic Compute Cloud EC2 (Amazon). Untuk informasi selengkapnya tentang cara menggunakan Targets parameter, lihat Jalankan perintah pada 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 penelusuran yang menargetkan instance dengan menggunakan kombinasi Kunci, Nilai yang Anda tentukan. Targetsdiperlukan jika Anda tidak memberikan satu atau lebih contoh IDs dalam panggilan. Untuk informasi selengkapnya tentang cara menggunakan Targets parameter, lihat Jalankan perintah pada skala.

Jenis: MapList (Skema peta dalam daftar harus cocok dengan objek.) Untuk selengkapnya, lihat Target di AWS Systems Manager APIReferensi.

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 lebih lanjut, lihat CloudWatchOutputConfigdi AWS Systems Manager APIReferensi).

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

DocumentHashType

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

ARNPeran AWS Identity and Access Management (IAM).

Tipe: String

Wajib: Tidak

TimeoutSeconds

Jumlah waktu dalam hitungan detik untuk menunggu perintah dikirim 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 GetCommandInvocation dan ListCommandInvocations API operasi untuk mengambil output untuk instance individual.