Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Referensi plugin dokumen perintah
Referensi ini menjelaskan plugin yang dapat Anda tentukan dalam dokumen tipe Command AWS Systems Manager (SSM). Plugin ini tidak dapat digunakan dalam runbook otomatisasi SSM, yang menggunakan tindakan otomatisasi. Untuk informasi tentang tindakan AWS Systems Manager Otomasi, lihatReferensi tindakan Otomatisasi Systems Manager.
Systems Manager menentukan tindakan untuk menjalankan instans terkelola dengan membaca isi dokumen SSM. Setiap dokumen termasuk bagian eksekusi kode. Tergantung pada versi skema dokumen Anda, bagian eksekusi kode ini dapat mencakup satu atau beberapa plugin atau langkah-langkah. Untuk tujuan topik bantuan ini, plugin dan langkah-langkah disebut sebagai plugin. Bagian ini mencakup informasi tentang setiap plugin Systems Manager. Untuk informasi lebih lanjut tentang dokumen, termasuk informasi tentang membuat dokumen dan perbedaan antara versi skema, lihat AWS Systems Manager Dokumen.
catatan
Beberapa plugin yang dijelaskan di sini hanya berjalan di salah satu Windows Server instance atau instance Linux. Dependensi platform dicatat dalam setiap plugin.
Plugin dokumen berikut didukung pada instans Amazon Elastic Compute Cloud EC2 (Amazon) macOS:
-
aws:refreshAssociation
-
aws:runShellScript
-
aws:runPowerShellScript
-
aws:softwareInventory
-
aws:updateSsmAgent
Daftar Isi
Input bersama
Dengan SSM Agent versi 3.0.502 dan yang lebih baru saja, semua plugin dapat menggunakan input berikut:
- finallyStep
-
Langkah terakhir untuk menjalankan dokumen yang Anda inginkan. Jika input ini ditentukan dalam sebuah langkah,
exit
lebih diutamakan dari nilai yang ditentukan dalamonFailure
atau inputonSuccess
. Dalam rangka untuk menjalankan langkah input ini seperti yang diharapkan, langkah terakhir yang harus ditentukan dalammainSteps
dari dokumen Anda.Tipe: Boolean
Nilai yang valid:
true
|false
Wajib: Tidak
- onFailure
-
Jika Anda menentukan input ini untuk plugin dengan nilai
exit
dan langkah gagal, status langkah mencerminkan kegagalan dan dokumen tidak menjalankan langkah-langkah yang tersisa kecualifinallyStep
yang telah ditentukan. Jika Anda menentukan input ini untuk plugin dengan nilaisuccessAndExit
dan langkah gagal, status langkah menunjukkan sukses dan dokumen tidak menjalankan langkah-langkah yang tersisa kecualifinallyStep
yang telah ditentukan.Tipe: String
Nilai yang valid:
exit
|successAndExit
Wajib: Tidak
- onSuccess
-
Jika Anda menentukan input ini untuk plugin dan langkah yang dijalankan berhasil, dokumen tidak menjalankan langkah-langkah yang tersisa kecuali
finallyStep
yang telah ditentukan.Tipe: String
Nilai valid:
exit
Wajib: Tidak
aws:applications
Instal, perbaiki, atau hapus instalan aplikasi pada sebuah EC2 instans. Plugin ini hanya berjalan pada Windows Server sistem operasi.
Sintaks
Skema 2.2
Skema 1.2
Properti
- tindakan
-
Tindakan yang harus diambil.
Jenis: Enum
Nilai valid:
Install
|Repair
|Uninstall
Wajib: Ya
- parameter
-
Parameter untuk penginstal.
Tipe: String
Wajib: Tidak
- sumber
-
URL dari file
.msi
untuk aplikasi.Tipe: String
Wajib: Ya
- sourceHash
-
SHA256 Hash dari
.msi
file tersebut.Tipe: String
Wajib: Tidak
aws:cloudWatch
Ekspor data dari Windows Server ke Amazon CloudWatch atau Amazon CloudWatch Log dan pantau data menggunakan CloudWatch metrik. Plugin ini hanya berjalan pada Windows Server sistem operasi. Untuk informasi selengkapnya tentang mengonfigurasi CloudWatch integrasi dengan Amazon Elastic Compute Cloud EC2 (Amazon), lihat Mengumpulkan metrik, log, dan jejak dengan CloudWatch agen di Panduan Pengguna Amazon CloudWatch .
penting
CloudWatch Agen terpadu telah diganti SSM Agent sebagai alat untuk mengirim data log ke Amazon CloudWatch Logs. Bagian SSM Agent AWS: Plugin CloudWatch tidak didukung. Sebaiknya gunakan hanya CloudWatch agen terpadu untuk proses pengumpulan log Anda. Untuk informasi selengkapnya, lihat topik berikut.
Anda dapat mengekspor dan memantau jenis data berikut:
- ApplicationEventLog
-
Mengirim data log peristiwa aplikasi ke CloudWatch Log.
- CustomLogs
-
Mengirim file log berbasis teks apa pun ke Amazon CloudWatch Logs. CloudWatch Plugin membuat sidik jari untuk file log. Sistem kemudian menghubungkan data offset dengan setiap sidik jari. Plugin mengunggah file ketika ada perubahan, rekaman offset, dan menghubungkan offset dengan sidik jari. Metode ini digunakan untuk menghindari situasi di mana pengguna menyalakan plugin, mengaitkan layanan dengan direktori yang berisi sebagian besar file, dan sistem mengunggah semua file.
Awas
Sadarilah bahwa jika aplikasi Anda memotong atau mencoba untuk membersihkan log selama polling, setiap log yang ditentukan untuk
LogDirectoryPath
dapat kehilangan entri. Jika, misalnya, Anda ingin membatasi ukuran file log, membuat file log baru ketika batas telah tercapai, dan kemudian melanjutkan menulis data ke file baru. - ETW
-
Mengirim data Event Tracing untuk Windows (ETW) ke CloudWatch Log.
- IIS
-
Mengirim data log IIS ke CloudWatch Log.
- PerformanceCounter
-
Mengirim penghitung kinerja Windows ke CloudWatch. Anda dapat memilih kategori yang berbeda untuk diunggah CloudWatch sebagai metrik. Untuk setiap penghitung kinerja yang ingin Anda unggah, buat PerformanceCounterbagian dengan ID unik (misalnya, "PerformanceCounter2"," PerformanceCounter 3", dan seterusnya) dan konfigurasikan propertinya.
catatan
Jika AWS Systems Manager SSM Agent atau CloudWatch plugin dihentikan, data penghitung kinerja tidak masuk CloudWatch. Perilaku ini berbeda dari log kustom atau log Peristiwa Windows. Log khusus dan log Peristiwa Windows mempertahankan data penghitung kinerja dan mengunggahnya ke CloudWatch setelahnya SSM Agent atau CloudWatch plugin tersedia.
- SecurityEventLog
-
Mengirim data log peristiwa keamanan ke CloudWatch Log.
- SystemEventLog
-
Mengirim data log peristiwa sistem ke CloudWatch Log.
Anda dapat menentukan tujuan untuk data berikut:
- CloudWatch
-
Tujuan pengiriman data metrik penghitung kinerja Anda. Anda dapat menambahkan lebih banyak bagian dengan unik IDs (misalnya, "CloudWatch2", CloudWatch 3", dan seterusnya), dan menentukan Wilayah yang berbeda untuk setiap ID baru untuk mengirim data yang sama ke lokasi yang berbeda.
- CloudWatchLogs
-
Tujuan dimana data log Anda dikirim. Anda dapat menambahkan lebih banyak bagian dengan unik IDs (misalnya, "CloudWatchLogs2", CloudWatchLogs 3", dan seterusnya), dan menentukan Wilayah yang berbeda untuk setiap ID baru untuk mengirim data yang sama ke lokasi yang berbeda.
Sintaks
"runtimeConfig":{ "aws:cloudWatch":{ "settings":{ "startType":"{{ status }}" }, "properties":"{{ properties }}" } }
Pengaturan dan properti
- AccessKey
-
Kunci akses ID Anda. Properti ini diperlukan kecuali Anda telah meluncurkan instans Anda menggunakan IAM role. Properti ini tidak dapat digunakan dengan SSM.
Tipe: String
Wajib: Tidak
- CategoryName
-
Kategori penghitungan kinerja dari Pemantauan kinerja.
Tipe: String
Diperlukan: Ya
- CounterName
-
Nama penghitung kinerja dari Pemantauan kinerja.
Tipe: String
Diperlukan: Ya
- CultureName
-
Lokal tempat stempel waktu dicatat. Jika CultureNamekosong, defaultnya ke lokal yang sama yang digunakan oleh Anda Windows Server contoh.
Tipe: String
Nilai yang benar: Untuk daftar nilai yang mendukung, lihat National Language Support (NLS)
di situs web Microsoft. Div, div-MV, hu, dan Hu-hu nilai tidak mendukung. Wajib: Tidak
- DimensionName
-
Dimensi untuk CloudWatch metrik Amazon Anda. Jika Anda menentukan
DimensionName
, Anda harus menentukanDimensionValue
. Parameter ini memberikan tampilan lain saat mendaftar metrik. Anda dapat menggunakan dimensi yang sama untuk beberapa metrik sehingga Anda dapat melihat semua metrik milik dimensi tertentu.Tipe: String
Wajib: Tidak
- DimensionValue
-
Nilai dimensi untuk CloudWatch metrik Amazon Anda.
Tipe: String
Wajib: Tidak
- Encoding
-
File pengodean yang akan digunakan (misalnya, UTF-8). Gunakan nama pengodean, bukan nama tampilan.
Tipe: String
Nilai yang valid: Untuk daftar nilai yang didukung, lihat Kelas Pengkodean
di Perpustakaan Microsoft Learn. Wajib: Ya
- Filter
-
Prefiks nama log. Biarkan parameter ini kosong untuk memantau semua file.
Tipe: String
Nilai yang valid: Untuk daftar nilai yang didukung, lihat FileSystemWatcherFilter Properti di Pustaka
MSDN. Wajib: Tidak
- Alur
-
Setiap tipe data yang akan diunggah, bersama dengan tujuan untuk data (CloudWatch atau CloudWatch Log). Misalnya, untuk mengirim penghitung kinerja yang ditentukan di bawah
"Id": "PerformanceCounter"
ke CloudWatch tujuan yang ditentukan di bawah"Id": "CloudWatch"
, masukkan "PerformanceCounter,CloudWatch". Demikian pula, untuk mengirim log kustom, log ETW, dan log sistem ke tujuan Log yang CloudWatch ditentukan di bawah"Id": "ETW"
, masukkan “(ETW), CloudWatchLogs”. Selain itu, Anda dapat mengirim penghitung kinerja yang sama atau berkas log ke lebih dari satu tujuan. Misalnya, untuk mengirim log aplikasi ke dua tujuan berbeda yang Anda tentukan di bawah"Id": "CloudWatchLogs"
dan"Id": "CloudWatchLogs2"
, masukkan "ApplicationEventLog, (CloudWatchLogs, CloudWatchLogs 2)”.Tipe: String
Nilai yang valid (sumber):
ApplicationEventLog
|CustomLogs
|ETW
|PerformanceCounter
|SystemEventLog
|SecurityEventLog
Nilai yang valid (tujuan):
CloudWatch
|CloudWatchLogs
|CloudWatch
n
|CloudWatchLogs
n
Wajib: Ya
- FullName
-
Nama lengkap pada komponen.
Tipe: String
Wajib: Ya
- Id
-
Mengidentifikasi sumber data atau tujuan. Pengidentifikasi ini harus unik dalam file konfigurasi.
Tipe: String
Diperlukan: Ya
- InstanceName
-
Nama penghitung kinerja instans. Jangan gunakan tanda bintang (*) untuk menunjukkan semua instans karena setiap komponen penghitung kinerja hanya mendukung satu metrik. Anda bisa, namun menggunakan _Total.
Tipe: String
Wajib: Ya
- Tingkat
-
Jenis pesan untuk dikirim ke Amazon CloudWatch.
Tipe: String
Nilai valid:
-
1 - Hanya pesan kesalahan yang diunggah.
-
2 - Hanya pesan peringatan yang diunggah.
-
4 - Hanya pesan informasi yang diunggah.
Anda dapat menambahkankan nilai-nilainya bersamaan untuk menyertakan lebih dari satu jenis pesan. Misalnya, 3 berarti bahwa pesan kesalahan (1) dan pesan peringatan (2) disertakan. Nilai dari 7 berarti bahwa pesan kesalahan (1), pesan peringatan (2), dan pesan informasi (4) disertakan.
Wajib: Ya
catatan
Log keamanan Windows harus diatur pada tingkat ke 7.
-
- LineCount
-
Jumlah baris di header untuk mengidentifikasi berkas log. Sebagai contoh, berkas log IIS memiliki header yang hampir identik. Anda bisa memasukkan 3, yang akan membaca tiga baris pertama header berkas log untuk mengidentifikasinya. Dalam file log IIS, baris ketiga adalah tanggal dan stempel waktu, yang berbeda antara file log.
Jenis: Integer
Wajib: Tidak
- LogDirectoryPath
-
Untuk CustomLogs, jalur tempat log disimpan pada EC2 instance Anda. Untuk log IIS, folder tempat log IIS disimpan untuk situs individual (misalnya, C:\\ inetpub\\ logs\\\\ W3SVC). LogFiles
n
Untuk log IIS, hanya format log W3C yang mendukung. IIS, NCSA, dan format kustom yang tidak mendukung.Tipe: String
Diperlukan: Ya
- LogGroup
-
Nama untuk grup log Anda. Nama ini ditampilkan di layar Grup Log di CloudWatch konsol.
Tipe: String
Diperlukan: Ya
- LogName
-
Nama file log.
-
Untuk menemukan nama log, di Event Viewer, di panel navigasi, pilih Log Aplikasi dan Layanan.
-
Dalam daftar log, klik kanan log yang ingin Anda upload (misalnya, Microsoft>Windows>Backup>Operasional), dan kemudian pilih Buat Tampilan Khusus.
-
Di Buat Tampilan Khusus kotak dialog, pilih XML tab. LogNameAda di tag <Select Path=> (misalnya,).
Microsoft-Windows-Backup
Salin teks ini ke dalam LogNameparameter.
Tipe: String
Nilai valid:
Application
|Security
|System
|Microsoft-Windows-WinINet/Analytic
Wajib: Ya
-
- LogStream
-
Pengaliran log tujuan. Jika Anda menggunakan {instance_id}, yaitu default-nya, instans ID pada instans ini digunakan sebagai nama stream log.
Tipe: String
Nilai yang valid:
{instance_id}
|{hostname}
|{ip_address}
<log_stream_name>
Jika Anda memasukkan nama aliran log yang belum ada, CloudWatch Log secara otomatis membuatnya untuk Anda. Anda dapat menggunakan string literal atau variabel yang telah ditetapkan ({instance_id}, {hostname}, {ip_address}, atau kombinasi dari ketiga untuk menentukan nama pengaliran log.
Nama aliran log yang ditentukan dalam parameter ini ditampilkan di Grup Log > Aliran untuk
<YourLogStream>
layar di CloudWatch konsol.Wajib: Ya
- MetricName
-
CloudWatch Metrik yang Anda inginkan data kinerja disertakan di bawah.
catatan
Jangan gunakan karakter khusus dalam nama. Jika Anda melakukannya, metrik dan alarm terkait mungkin tidak berfungsi.
Tipe: String
Diperlukan: Ya
- NameSpace
-
Namespace metrik di mana Anda ingin penulisan data penghitungan kinerja.
Tipe: String
Diperlukan: Ya
- PollInterval
-
Berapa detik berlalu sebelum penghitung kinerja baru dan data log diunggah.
Jenis: Integer
Nilai valid: Atur ini dalam 5 detik atau lebih. Disarankan lima belas detik (00:00:15).
Wajib: Ya
- Wilayah
-
Wilayah AWS Tempat Anda ingin mengirim data log. Meskipun Anda dapat mengirim penghitung kinerja ke Wilayah yang berbeda dari tempat Anda mengirim data log Anda, kami sarankan Anda menetapkan parameter ini untuk Wilayah yang sama di mana instans Anda berjalan.
Tipe: String
Nilai yang valid: Wilayah IDs yang Wilayah AWS didukung oleh Systems Manager dan CloudWatch Log, seperti
us-east-2
,eu-west-1
, danap-southeast-1
. Untuk daftar yang Wilayah AWS didukung oleh setiap layanan, lihat Titik Akhir Layanan Amazon CloudWatch Logs dan titik akhir layanan Systems Manager di. Referensi Umum Amazon Web ServicesWajib: Ya
- SecretKey
-
Kunci akses rahasia Anda. Properti ini diperlukan kecuali Anda telah meluncurkan instans Anda menggunakan IAM role.
Tipe: String
Wajib: Tidak
- startType
-
Nyalakan atau matikan CloudWatch pada instance.
Tipe: String
Nilai yang valid:
Enabled
|Disabled
Wajib: Ya
- TimestampFormat
-
Format waktu yang ingin Anda gunakan. Untuk daftar nilai yang mendukung, lihat Custom Date and Time Format Strings
di Perpustakaan MSDN. Tipe: String
Diperlukan: Ya
- TimeZoneKind
-
Memberikan informasi zona waktu ketika tidak ada informasi zona waktu yang disertakan dalam stempel waktu log Anda. Jika parameter ini dibiarkan kosong dan jika stempel waktu Anda tidak menyertakan informasi zona waktu, CloudWatch Log default ke zona waktu lokal. Parameter ini diabaikan jika stempel waktu Anda sudah berisi informasi zona waktu.
Tipe: String
Nilai yang valid:
Local
|UTC
Wajib: Tidak
- Unit
-
Unit pengukuran yang tepat untuk metrik.
Tipe: String
Nilai yang valid: Detik | Mikrodetik | Milidetik | Byte | Kilobyte | Megabyte | Gigabyte | Terabyte | Bit | Kilobit | Megabits | Gigabits | Terabits | Persen | Hitungan | | Tidak ada Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second
Wajib: Ya
aws:configureDocker
(Skema versi 2.0 atau yang lebih baru) Mengkonfigurasi instans untuk bekerja dengan kontainer dan Docker. Plugin ini didukung pada sebagian besar varian Linux dan Windows Server sistem operasi.
Sintaks
Skema 2.2
Masukan
- tindakan
-
Jenis tindakan yang harus dilakukan.
Jenis: Enum
Nilai valid:
Install
|Uninstall
Wajib: Ya
aws:configurePackage
(Skema versi 2.0 atau yang lebih baru) Instal atau hapus instalan AWS Systems Manager Distributor paket. Anda dapat menginstal versi terbaru, versi default, atau versi paket yang Anda tentukan. Paket yang AWS disediakan juga didukung. Plugin ini berjalan pada Windows Server dan sistem operasi Linux, tetapi tidak semua paket yang tersedia didukung pada sistem operasi Linux.
AWS Paket yang tersedia untuk Windows Server termasuk yang berikut:AWSPVDriver
,AWSNVMe
,AwsEnaNetworkDriver
,AwsVssComponents
,AmazonCloudWatchAgent
,CodeDeployAgent
, dan AWSSupport-EC2Rescue.
AWS Paket yang tersedia untuk sistem operasi Linux meliputi:AmazonCloudWatchAgent
,CodeDeployAgent
, danAWSSupport-EC2Rescue
.
Sintaks
Skema 2.2
Masukan
- name
-
Nama AWS paket untuk menginstal atau menghapus instalasi. Paket-paket yang tersedia meliputi:
AWSPVDriver
,AwsEnaNetworkDriver
,AwsVssComponents
, danAmazonCloudWatchAgent
.Tipe: String
Wajib: Ya
- tindakan
-
Menginstal atau menghapus paket.
Jenis: Enum
Nilai valid:
Install
|Uninstall
Wajib: Ya
- installationType
-
Jenis instalasi untuk menjalankan. Jika Anda menentukan
Uninstall and reinstall
, paket benar-benar dihapus, dan kemudian diinstal ulang. Aplikasi ini tidak tersedia sampai penginstalan ulang selesai. Jika Anda menentukanIn-place update
, hanya file baru atau diubah yang ditambahkan ke instalasi yang ada sesuai dengan petunjuk yang Anda berikan dalam skrip pembaruan. Aplikasi tetap tersedia selama proses pembaruan.In-place update
Opsi ini tidak didukung untuk paket AWS-published.Uninstall and reinstall
adalah nilai default.Jenis: Enum
Nilai valid:
Uninstall and reinstall
|In-place update
Wajib: Tidak
- additionalArguments
-
String JSON dari parameter tambahan yang akan disediakan untuk menginstal, menghapus instalasi, atau memperbarui skrip Anda. Setiap parameter harus diawali dengan
SSM_
. Anda dapat mereferensikan Parameter Store parameter dalam argumen tambahan Anda dengan menggunakan konvensi{{ssm:
. Untuk menggunakan parameter tambahan dalam skrip install, uninstall, atau update, referensi parameter Anda harus sebagai variabel lingkungan menggunakan sintaks yang sesuai untuk sistem operasi. Misalnya, di PowerShell, Anda mereferensikanparameter-name
}}SSM_arg
argumen sebagai$Env:SSM_arg
. Tidak ada batas jumlah argumen yang Anda tentukan, tetapi input argumen tambahan memiliki batas karakter 4096. Batas ini mencakup semua kunci dan nilai yang Anda tentukan.Jenis: StringMap
Wajib: Tidak
- versi
-
Versi tertentu dari paket untuk menginstal atau menghapus instalasi. Jika memasang, sistem memasang versi terbaru yang diterbitkan, secara default. Jika menghapus instalasi, sistem menghapus instalasi versi yang dipasang pada masa ini, secara default. Jika tidak ada versi yang diinstal ditemukan, versi terbaru yang dipublikasi telah diunduh, dan tindakan uninstall dijalankan.
Tipe: String
Wajib: Tidak
aws:domainJoin
Bergabunglah dengan sebuah EC2 instance ke domain. Plugin ini berjalan di Linux dan Windows Server sistem operasi. Plugin ini mengubah nama host untuk instance Linux ke format EC2 AMAZ-. XXXXXXX
Untuk informasi selengkapnya tentang bergabung dengan EC2 instans, lihat Menggabungkan EC2 Instans ke Direktori Microsoft AD AWS Terkelola Anda di Panduan AWS Directory Service Administrasi.
Sintaks
Skema 2.2
Skema 1.2
Properti
- directoryId
-
ID direktori.
Tipe: String
Wajib: Ya
Contoh: "directoryId": "d-1234567890"
- directoryName
-
Nama domain.
Tipe: String
Wajib: Ya
Contoh: "directoryName": "example.com"
- directoryOU
-
Unit organisasi (OU).
Tipe: String
Wajib: Tidak
Contoh: "directoryOU": "OU=test,DC=example,DC=com"
- dnsIpAddresses
-
Alamat IP dari server DNS.
Jenis: StringList
Wajib: Ya
Contoh: "dnsIpAddresses“: [" 198.51.100.1", "198.51.100.2"]
- hostname
-
Nama host yang ingin Anda tetapkan ke node.
Tipe: String
Wajib: Tidak
- keepHostName
-
Menentukan apakah nama host diubah untuk instance Linux saat bergabung ke domain.
Tipe: Boolean
Wajib: Tidak
Contoh
Sebagai contoh, lihat Menggabungkan EC2 Instans Amazon ke AWS Managed Microsoft AD dalam Panduan AWS Directory Service Administrasi.
aws:downloadContent
(Skema versi 2.0 atau yang lebih baru) Unduh dokumen SSM dan skrip dari lokasi jarak jauh. GitHub Enterprise repositori tidak didukung. Plugin ini didukung di Linux dan Windows Server sistem operasi.
Sintaks
Skema 2.2
Masukan
- sourceType
-
Sumber unduhan. Systems Manager mendukung jenis sumber berikut untuk men-download skrip dan dokumen SSM:
GitHub
,Git
,HTTP
,S3
, danSSMDocument
.Tipe: String
Wajib: Ya
- sourceInfo
-
Informasi yang diperlukan untuk mengambil konten dari sumber yang diperlukan.
Jenis: StringMap
Wajib: Ya
Untuk SourceType tentukan yang
GitHub,
berikut:-
owner: Pemilik repositori.
-
repositori: Nama repositori.
-
jalur: Jalur ke file atau direktori yang ingin Anda unduh.
-
getOptions: Pilihan tambahan untuk mengambil konten dari cabang selain cabang utama atau dengan komit repositori tertentu. getOptions dapat dihilangkan jika Anda menggunakan komit terbaru di cabang utama. Jika repositori Anda dibuat setelah 1 Oktober 2020 cabang default mungkin diberi nama main (utama) dan bukan master (utama). Dalam hal ini, Anda perlu menentukan nilai untuk parameter GetOptions.
Parameter ini menggunakan format berikut:
-
cabang: refs/kepala/
branch_name
Default-nya adalah
master
.Untuk menentukan cabang non-default gunakan format berikut:
cabang: refs/kepala/
branch_name
-
CommitiD:
commitID
Default-nya adalah
head
.Untuk menggunakan versi dokumen SSM Anda di komit selain yang terbaru, tentukan ID komit penuh. Sebagai contoh:
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
-
-
TokenInfo: Parameter Systems Manager (parameter) SecureString tempat Anda menyimpan GitHub akses informasi token, dalam format
{{ssm-secure:
.secure-string-token-name
}}catatan
tokenInfo
Bidang ini adalah satu-satunya bidang plugin dokumen SSM yang mendukung SecureString parameter. SecureString parameter tidak didukung untuk bidang lain, atau untuk plugin dokumen SSM lainnya.
{ "owner":"TestUser", "repository":"
GitHubTest
", "path":"scripts/python/test-script
", "getOptions":"branch:master", "tokenInfo":"{{ssm-secure:secure-string-token
}}" }Untuk SourceType, Anda
Git
harus menentukan yang berikut ini:-
repositori
URL repositori Git ke file atau direktori yang ingin Anda unduh.
Tipe: String
Selain itu, Anda dapat menentukan parameter opsional berikut:
-
GetOptions
Pilihan tambahan untuk mengambil konten dari cabang selain cabang utaman atau dari komit tertentu dalam repositori. GetOptions dapat dihilangkan jika Anda menggunakan komit terbaru di cabang utama.
Tipe: String
Parameter ini menggunakan format berikut:
-
cabang: refs/kepala/
branch_name
Default-nya adalah
master
."branch"
diperlukan hanya jika dokumen SSM Anda disimpan di cabang selainmaster
. Sebagai contoh:"getOptions": "branch:refs/heads/main"
-
CommitiD:
commitID
Default-nya adalah
head
.Untuk menggunakan versi dokumen SSM Anda di komit selain yang terbaru, tentukan ID komit penuh. Sebagai contoh:
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
-
-
pribadi SSHKey
Kunci SSH untuk digunakan saat menghubungkan ke
repository
yang Anda tentukan. Anda dapat menggunakan format berikut untuk referensi parameterSecureString
pada nilai kunci SSH Anda:{{ssm-secure:
.your-secure-string-parameter
}}Tipe: String
-
skipHostKeyMemeriksa
Menentukan nilai StrictHostKeyChecking opsi saat menghubungkan ke yang
repository
Anda tentukan. Nilai default-nya adalahfalse
.Jenis: Boolean
-
nama pengguna
Nama pengguna yang digunakan saat menghubungkan ke
repository
yang Anda tentukan menggunakan HTTP. Anda dapat menggunakan format berikut untuk referensi parameterSecureString
untuk nilai nama pengguna Anda:{{ssm-secure:
.your-secure-string-parameter
}}Tipe: String
-
Kata sandi
Kata sandi digunakan saat menghubungkan ke
repository
yang Anda tentukan menggunakan HTTP. Anda dapat menggunakan format berikut untuk referensi parameterSecureString
untuk nilai kata sandi Anda:{{ssm-secure:
.your-secure-string-parameter
}}Tipe: String
Untuk SourceType, Anda
HTTP
harus menentukan yang berikut ini:-
url
URL ke file atau direktori yang ingin Anda unduh.
Tipe: String
Selain itu, Anda dapat menentukan parameter opsional berikut:
-
allowInsecureDownload
Tentukan apakah unduhan dapat dilakukan melalui sambungan yang tidak dienkripsi dengan Secure Socket Layer (SSL) atau Transport Layer (TLS). Nilai default-nya adalah
false
. Kami tidak menyarankan untuk melakukan unduhan tanpa enkripsi. Jika Anda memilih untuk melakukannya, Anda menanggung semua risiko yang berkaitan. Keamanan adalah tanggung jawab bersama antara Anda AWS dan Anda. Hal ini digambarkan sebagai model tanggung jawab bersama. Untuk mempelajari informasi lebih lanjut, lihat Model tanggung jawab bersama. Jenis: Boolean
-
authMethod
Tentukan apakah nama pengguna dan kata sandi yang digunakan untuk otentikasi saat menghubungkan ke
url
yang Anda tentukan. Jika Anda menentukanBasic
atauDigest
, Anda harus memberikan nilai untuk parameterusername
danpassword
. Untuk menggunakanDigest
metode ini, SSM Agent versi 3.0.1181.0 atau yang lebih baru harus diinstal pada instance Anda.Digest
Metode ini mendukung MD5 dan SHA256 enkripsi.Tipe: String
Nilai valid:
None
|Basic
|Digest
-
nama pengguna
Nama pengguna yang digunakan saat menghubungkan ke
url
yang anda tentukan menggunakan AutentikasiBasic
. Anda dapat menggunakan format berikut untuk referensi parameterSecureString
untuk nilai nama pengguna Anda:{{ssm-secure:
.your-secure-string-parameter
}}Tipe: String
-
Kata sandi
Kata sandi untuk digunakan saat menghubungkan ke
url
yang anda tentukan menggunakan AutentikasiBasic
. Anda dapat menggunakan format berikut untuk referensi parameterSecureString
untuk nilai kata sandi Anda:{{ssm-secure:
.your-secure-string-parameter
}}Tipe: String
Untuk SourceType,
S3
tentukan yang berikut ini:-
jalur: URL ke file atau direktori yang ingin Anda unduh dari Amazon S3.
{ "path": "https://s3.amazonaws.com/
amzn-s3-demo-bucket
/powershell/helloPowershell.ps1" }Untuk SourceType,
SSMDocument
tentukan salah satu dari berikut ini:-
Nama: Nama dan versi dokumen dalam format berikut:
name:version
. Versi adalah opsional.{ "name": "Example-RunPowerShellScript:3" }
-
Nama: ARN untuk dokumen dalam format berikut:
arn:aws:ssm:
region
:account_id
:document/document_name
{ "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc" }
-
- destinationPath
-
Jalur lokal opsional instans ada ditempat Anda ingin mengunduh file. Jika Anda tidak menentukan jalurnya, konten diunduh ke jalur relatif pada ID perintah Anda.
Tipe: String
Wajib: Tidak
aws:psModule
Instal PowerShell modul pada EC2 instans Amazon. Plugin ini hanya berjalan pada Windows Server sistem operasi.
Sintaks
Skema 2.2
Skema 1.2
Properti
- runCommand
-
PowerShell Perintah untuk menjalankan setelah modul diinstal.
Jenis: StringList
Wajib: Tidak
- sumber
-
URL atau jalur lokal pada instans untuk aplikasi file
.zip
.Tipe: String
Wajib: Ya
- sourceHash
-
SHA256 Hash dari
.zip
file tersebut.Tipe: String
Wajib: Tidak
- timeoutSeconds
-
Waktu dalam detik untuk perintah yang harus diselesaikan sebelum dianggap telah gagal.
Tipe: String
Wajib: Tidak
- workingDirectory
-
Jalur direktori kerja pada instans Anda.
Tipe: String
Wajib: Tidak
aws:refreshAssociation
(Skema versi 2.0 atau yang terbaru) Segarkan (berlaku paksa) sebuah asosiasi sesuai permintaan. Tindakan ini akan mengubah status sistem berdasarkan pada apa yang ditentukan dalam asosiasi yang dipilih atau semua asosiasi yang terikat pada target. Plugin ini berjalan di Linux dan Microsoft Windows Server sistem operasi.
Sintaks
Skema 2.2
Masukan
- associationIds
-
Daftar asosiasi IDs. Jika kosong, semua asosiasi yang berhubungan dengan target yang ditentukan telah diterapkan.
Jenis: StringList
Wajib: Tidak
aws:runDockerAction
(Skema versi 2.0 atau yang terbaru) Menjalankan tindakan Docker pada kontainer. Plugin ini berjalan di Linux dan Microsoft Windows Server sistem operasi.
Sintaks
Skema 2.2
Masukan
- tindakan
-
Jenis tindakan yang harus dilakukan.
Tipe: String
Wajib: Ya
- kontainer
-
ID kontainer Docker.
Tipe: String
Wajib: Tidak
- image
-
Nama gambar Docker.
Tipe: String
Wajib: Tidak
- cmd
-
Perintah kontainer.
Tipe: String
Wajib: Tidak
- memori
-
Batas memori kontainer.
Tipe: String
Wajib: Tidak
- cpuShares
-
Pembagian CPU kontainer (berat relatif).
Tipe: String
Wajib: Tidak
- volume
-
Pemasangan volume kontainer.
Jenis: StringList
Wajib: Tidak
- env
-
Variabel lingkungan kontainer.
Tipe: String
Wajib: Tidak
- pengguna
-
Nama pengguna kontainer.
Tipe: String
Wajib: Tidak
- menerbitkan
-
Port kontainer diterbitkan.
Tipe: String
Wajib: Tidak
aws:runDocument
(Skema versi 2.0 atau yang terbaru) Menjalankan dokumen SSM yang disimpan di Systems Manager atau pada berbagi lokal. Anda dapat menggunakan plugin ini dengan plugin aws:downloadContent untuk mengunduh dokumen SSM dari lokasi jarak jauh untuk berbagi lokal, dan kemudian jalankannya. Plugin ini didukung di Linux dan Windows Server sistem operasi. Plugin ini tidak mendukung menjalankan AWS-UpdateSSMAgent
dokumen atau dokumen apa pun yang menggunakan aws:updateSsmAgent
plugin.
Sintaks
Skema 2.2
Masukan
- documentType
-
Jenis dokumen untuk dijalankan. Anda dapat menjalankan dokumen lokal (
LocalPath
) atau dokumen yang disimpan dalam Systems Manager (SSMDocument
).Tipe: String
Wajib: Ya
- documentPath
-
Jalur ke dokumen. Jika
documentType
adalahLocalPath
, kemudian tentukan jalur ke dokumen pada berbagi lokal. JikadocumentType
adalahSSMDocument
, kemudian tentukan nama dokumen.Tipe: String
Wajib: Tidak
- documentParameters
-
Parameter untuk dokumen.
Jenis: StringMap
Wajib: Tidak
aws:runPowerShellScript
Jalankan PowerShell skrip atau tentukan jalur ke skrip yang akan dijalankan. Plugin ini berjalan di Microsoft Windows Server dan sistem operasi Linux.
Sintaks
Skema 2.2
Skema 1.2
Properti
- runCommand
-
Tentukan perintah untuk menjalankan atau jalur skrip yang ada pada instans.
Jenis: StringList
Wajib: Ya
- timeoutSeconds
-
Waktu dalam detik untuk perintah yang harus diselesaikan sebelum dianggap telah gagal. Ketika batas waktu tercapai, Systems Manager berhenti mengeksekusi perintah.
Tipe: String
Wajib: Tidak
- workingDirectory
-
Jalur direktori kerja pada instans Anda.
Tipe: String
Wajib: Tidak
aws:runShellScript
Jalankan skrip shell Linux atau tentukan jalur untuk menjalankan skrip. Plugin ini hanya berjalan pada sistem operasi Linux.
Sintaks
Skema 2.2
Skema 1.2
Properti
- runCommand
-
Tentukan perintah untuk menjalankan atau jalur skrip yang ada pada instans.
Jenis: StringList
Wajib: Ya
- timeoutSeconds
-
Waktu dalam detik untuk perintah yang harus diselesaikan sebelum dianggap telah gagal. Ketika batas waktu tercapai, Systems Manager berhenti mengeksekusi perintah.
Tipe: String
Wajib: Tidak
- workingDirectory
-
Jalur direktori kerja pada instans Anda.
Tipe: String
Wajib: Tidak
aws:softwareInventory
(Skema versi 2.0 atau yang terbaru) Kumpulkan metadata tentang aplikasi, file, dan konfigurasi pada instans terkelola Anda. Plugin ini berjalan di Linux dan Microsoft Windows Server sistem operasi. Saat Anda mengonfigurasi koleksi inventaris, Anda mulai dengan membuat AWS Systems Manager State Manager asosiasi. Systems Manager mengumpulkan data inventaris saat asosiasi dijalankan. Jika Anda tidak membuat asosiasi terlebih dahulu, dan mencoba untuk meminta plugin aws:softwareInventory
sistem akan menampilkan kesalahan berikut:
The aws:softwareInventory
plugin can only be invoked via ssm-associate.
Instans hanya dapat mengonfigurasi satu asosiasi inventaris dalam satu waktu. Jika Anda mengonfigurasi instans dengan dua atau beberapa asosiasi, inventaris tidak berjalan dan tidak ada data inventaris yang dikumpulkan. Untuk informasi lebih lanjut tentang pengumpulan inventaris, lihat AWS Systems Manager Inventaris.
Sintaks
Skema 2.2
Masukan
- aplikasi
-
(Opsional) Kumpulkan metadata untuk aplikasi yang diinstal.
Tipe: String
Wajib: Tidak
- awsComponents
-
(Opsional) Kumpulkan metadata untuk AWS komponen seperti. amazon-ssm-agent
Tipe: String
Wajib: Tidak
- file
-
(Opsional, membutuhkan SSM Agent versi 2.2.64.0 atau yang lebih baru) Kumpulkan metadata untuk file, termasuk nama file, file waktu dibuat, file waktu terakhir diubah dan diakses, dan ukuran file, untuk beberapa nama. Untuk informasi lebih lanjut tentang pengumpulan file inventaris, lihat Menggunakan file dan inventaris registri Windows.
Tipe: String
Wajib: Tidak
- NetworkConfig
-
(Opsional) Kumpulkan metadata untuk konfigurasi jaringan.
Tipe: String
Wajib: Tidak
- Info Penagihan
-
(Opsional) Kumpulkan metadata untuk detail platform yang terkait dengan kode penagihan AMI.
Tipe: String
Wajib: Tidak
- windowsUpdates
-
(Opsional) Kumpulkan metadata untuk semua pembaruan Windows.
Tipe: String
Wajib: Tidak
- instanceDetailedInformation
-
(Opsional) Kumpulkan lebih banyak informasi instans yang disediakan oleh plugin inventaris default (
aws:instanceInformation
), termasuk model CPU, kecepatan, dan jumlah inti, untuk beberapa nama.Tipe: String
Wajib: Tidak
- layanan
-
(Opsional, hanya OS Windows, membutuhkan SSM Agent versi 2.2.64.0 atau yang lebih baru) Kumpulkan metadata untuk konfigurasi layanan.
Tipe: String
Wajib: Tidak
- windowsRegistry
-
(Opsional, hanya OS Windows, membutuhkan SSM Agent versi 2.2.64.0 atau yang lebih baru) Kumpulkan kunci dan nilai Windows Registry. Anda dapat memilih jalur kunci dan mengumpulkan semua kunci dan nilai secara berulang. Anda juga dapat mengumpulkan kunci registri tertentu dan nilainya untuk jalur tertentu. Inventaris mengumpulkan jalur, nama, jenis, dan nilai kunci. Untuk informasi lebih lanjut tentang pengumpulan inventaris Registri Windows, lihat Menggunakan file dan inventaris registri Windows.
Tipe: String
Wajib: Tidak
- windowsRoles
-
(Opsional, hanya OS Windows, membutuhkan SSM Agent versi 2.2.64.0 atau yang lebih baru) Kumpulkan metadata untuk konfigurasi peran Microsoft Windows.
Tipe: String
Wajib: Tidak
- customInventory
-
(Opsional) Kumpulkan data inventaris kustom. Untuk informasi lebih lanjut tentang inventaris kustom, lihat Menggunakan inventaris kustom
Tipe: String
Wajib: Tidak
- customInventoryDirectory
-
(Opsional) Kumpulkan data inventaris khusus dari direktori yang ditentukan. Untuk informasi lebih lanjut tentang inventaris kustom, lihat Menggunakan inventaris kustom
Tipe: String
Wajib: Tidak
aws:updateAgent
Perbarui layanan EC2 Config ke versi terbaru atau tentukan versi yang lebih lama. Plugin ini hanya berjalan di Microsoft Windows Server sistem operasi. Untuk informasi selengkapnya tentang layanan EC2 Config, lihat Mengonfigurasi Instans Windows menggunakan layanan EC2 Config (lama) di Panduan Pengguna Amazon. EC2
Sintaks
Skema 2.2
Skema 1.2
Properti
- agentName
-
EC2Config. Ini adalah nama agen yang menjalankan layanan EC2 Config.
Tipe: String
Wajib: Ya
- allowDowngrade
-
Izinkan layanan EC2 Config diturunkan ke versi sebelumnya. Jika diatur ke false, hanya layanan (default) yang dapat ditingkatkan ke versi yang terbaru. Jika diatur ke true, tentukan versi sebelumnya.
Tipe: Boolean
Wajib: Tidak
- sumber
-
Lokasi di mana Systems Manager menyalin versi EC2 Config untuk diinstal. Anda tidak dapat mengubah lokasi ini.
Tipe: String
Wajib: Ya
- targetVersion
-
Versi tertentu dari layanan EC2 Config yang akan diinstal. Jika tidak ditentukan, layanan akan diperbarui ke versi terbaru.
Tipe: String
Wajib: Tidak
aws:updateSsmAgent
Perbarui SSM Agent ke versi terbaru atau tentukan versi yang lebih lama. Plugin ini berjalan di Linux dan Windows Server sistem operasi. Untuk informasi selengkapnya, lihat Bekerja dengan SSM Agent.
Sintaks
Skema 2.2
Skema 1.2
Properti
- agentName
-
amazon-ssm-agent. Ini adalah nama agen Systems Manager yang memproses permintaan dan menjalankan perintah pada instance.
Tipe: String
Wajib: Ya
- allowDowngrade
-
Izinkan SSM Agent untuk diturunkan ke versi sebelumnya. Jika diatur ke false, hanya agen (default) yang dapat ditingkatkan ke versi yang terbaru. Jika diatur ke true, tentukan versi sebelumnya.
Tipe: Boolean
Wajib: Ya
- sumber
-
Lokasi di mana Systems Manager menyalin SSM Agent versi untuk menginstal. Anda tidak dapat mengubah lokasi ini.
Tipe: String
Wajib: Ya
- targetVersion
-
Versi tertentu dari SSM Agent untuk menginstal. Jika tidak ditentukan, agen akan diperbarui ke versi terbaru.
Tipe: String
Wajib: Tidak