Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Tindakan langkah yang didukung untuk dokumen alur kerja Anda
Bagian ini mencakup detail untuk tindakan langkah yang didukung Pembuat Gambar.
Istilah yang digunakan dalam bagian ini
- AMI
-
Gambar Mesin Amazon
- ARN
-
Nama Sumber Daya Amazon
Tabel berikut menunjukkan tahapan alur kerja mana yang mendukung setiap tindakan langkah. Tanda centang (X) menunjukkan bahwa Anda dapat menggunakan tindakan langkah pada tahap itu. Image Builder membatasi beberapa tindakan untuk tahapan tertentu: ExecuteComponents ke tahap pembuatan dan pengujian, CollectImageScanFindings ke tahap pengujian, danDistributeImage,ModifyImageAttributes,ApplyImageConfigurations, dan DistributeContainerImage ke tahap distribusi. Anda dapat menggunakan setiap tindakan lain dalam tahap apa pun.
| Tindakan langkah | Build | Uji | Distribusi | Catatan |
|---|---|---|---|---|
| LaunchInstance | X | X | X | Meluncurkan instans Amazon EC2. |
| BootstrapInstanceForContainer | X | X | X | Menginstal Docker dan build container AWS CLI for. |
| ExecuteComponents | X | X | Menjalankan komponen pada instance. Terbatas untuk tahap pembuatan dan pengujian. | |
| CollectImageMetadata | X | X | X | AMI dibangun saja. |
| RunSysPrep | X | X | X | Windows dibangun. |
| SanitizeInstance | X | X | X | Linux AMI dibangun; bukan untuk kontainer. |
| CreateImage | X | X | X | Membuat AMI dari instance build. |
| CreateImageFromIso | X | X | X | Membuat AMI dari image disk ISO. |
| RegisterImage | X | X | X | Mendaftarkan AMI dari snapshot. |
| DistributeContainerImage | X | Mendistribusikan gambar kontainer. Terbatas pada tahap distribusi. | ||
| CollectImageScanFindings | X | Mengumpulkan temuan pemindaian gambar. Terbatas pada tahap pengujian. Membutuhkan Amazon Inspector dan pemindaian gambar. | ||
| RunCommand | X | X | X | Menjalankan dokumen perintah AWS Systems Manager (Manajer Sistem). |
| WaitForSSMAgent | X | X | X | Menunggu konektivitas Manajer Sistem setelah reboot. |
| WaitForAction | X | X | X | Jeda untuk tindakan eksternal. |
| ExecuteStateMachine | X | X | X | Menjalankan mesin status Fungsi Langkah. |
| TerminateInstance | X | X | X | Mengakhiri sebuah instance. Misalnya, alur kerja distribusi container mengakhiri instance build setelah mendorong gambar. |
| DistributeImage | X | Menyalin AMI ke Wilayah dan akun. Terbatas pada tahap distribusi. | ||
| ModifyImageAttributes | X | Memodifikasi izin peluncuran AMI. Terbatas pada tahap distribusi. | ||
| ApplyImageConfigurations | X | Menerapkan template peluncuran, lisensi, ekspor, peluncuran cepat, dan parameter Manajer Sistem. Terbatas pada tahap distribusi. |
penting
Sebuah alur kerja tunggal mendistribusikan AMI atau gambar kontainer, bukan keduanya. Jika alur kerja termasukDistributeContainerImage, alur kerja juga tidak dapat menyer DistributeImage takanModifyImageAttributes,, atauApplyImageConfigurations. Tindakan distribusi AMI ini beroperasi pada AMI Amazon EC2, sementara DistributeContainerImage beroperasi pada gambar kontainer di Amazon Elastic Container Registry (Amazon ECR).
Tindakan yang didukung
ApplyImageConfigurations
Gunakan tindakan langkah ini untuk menerapkan berbagai konfigurasi dan integrasi ke AMI terdistribusi, seperti konfigurasi lisensi, konfigurasi template peluncuran, konfigurasi ekspor S3, konfigurasi Peluncuran Cepat EC2, dan konfigurasi parameter Manajer Sistem. Konfigurasi berlaku untuk gambar terdistribusi hanya di akun sumber, kecuali untuk konfigurasi parameter SSM yang dapat diterapkan lintas akun.
catatan
In configurations putnya opsional. Jika Anda menyediakannya, Image Builder menggunakan input alur kerja Anda dan mengabaikan konfigurasi distribusi terlampir. Jika Anda menghilangkannya, Image Builder kembali ke konfigurasi distribusi yang dilampirkan ke pipeline atau gambar.
Batas Waktu Default: 360 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini. In distributedImages.$ put diperlukan. Baris yang tersisa menggambarkan bidang dalam setiap item configurations array.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| DistributorDimages. $ | Daftar gambar yang didistribusikan untuk dikonfigurasi. Referensi distributedImages kan output dari DistributeImage langkah dalam alur kerja yang sama. |
Tali | Ya | Referensi JSONPath yang dimulai dengan $.stepOutputs. |
|
| susunan | Konfigurasi untuk diterapkan ke AMI terdistribusi, sebagai daftar. Setiap item menargetkan satu AWS Wilayah. | Array | Tidak | ||
| konfigurasi:wilayah | Wil AWS ayah AMI yang didistribusikan untuk dikonfigurasi. | Tali | Ya | Diperlukan untuk setiap item diconfigurations. |
|
| konfigurasi:lisensi ConfigurationArns | Konfigurasi lisensi ARN untuk gambar. | Array | Tidak | ||
| konfigurasi:peluncuran TemplateConfigurations | Konfigurasi template peluncuran untuk diterapkan ke AMI terdistribusi. | Array | Tidak | ||
| konfigurasi:peluncuran TemplateConfigurations:launchTemplateId | ID template peluncuran untuk diterapkan pada gambar. | String | Ya jika launchTemplateConfigurations ditentukan |
||
| konfigurasi:peluncuran TemplateConfigurations:accountId | ID akun template peluncuran untuk diterapkan pada gambar. | String | Tidak | ||
| konfigurasi:peluncuran TemplateConfigurations:setDefaultVersion | Pengaturan versi default template peluncuran untuk gambar. | Boolean | Tidak | ||
| Konfigurasi: s3 ExportConfiguration | Konfigurasi ekspor Amazon S3 untuk AMI terdistribusi. | Array | Tidak | ||
| Konfigurasi: s3 ExportConfiguration:roleName | Nama peran konfigurasi ekspor Amazon S3 untuk gambar. | String | Ya jika s3ExportConfiguration ditentukan |
||
| Konfigurasi: s3 ExportConfiguration:diskImageFormat | Format gambar disk konfigurasi ekspor Amazon S3 untuk gambar. | String | Ya jika s3ExportConfiguration ditentukan |
Nilai yang diizinkan - VMDK|RAW|VHD | |
| Konfigurasi: s3 ExportConfiguration:s3Bucket | Nama bucket konfigurasi ekspor Amazon S3 untuk gambar. | String | Ya jika s3ExportConfiguration ditentukan |
||
| Konfigurasi: s3 ExportConfiguration:s3Prefix | Awalan bucket konfigurasi ekspor Amazon S3 untuk gambar. | String | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations | Konfigurasi Peluncuran Cepat Amazon EC2 untuk gambar. | Array | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations:enabled | Apakah Amazon EC2 Fast Launch diaktifkan untuk gambar. | Boolean | Ya jika fastLaunchConfigurations ditentukan |
||
| Konfigurasi:cepat LaunchConfigurations:snapshotConfiguration | Konfigurasi snapshot untuk snapshot Peluncuran Cepat Amazon EC2 pra-penyediaan. | Peta | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations:snapshotConfiguration:targetResourceCount | Jumlah sumber daya target Peluncuran Cepat Amazon EC2 untuk gambar. | Bilangan Bulat | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations:maxParallelLaunches | Peluncuran paralel maksimum Amazon EC2 Fast Launch untuk gambar. | Bilangan Bulat | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations:launchTemplate | Template peluncuran yang digunakan Amazon EC2 Fast Launch untuk menyiapkan snapshot yang telah disediakan sebelumnya. | Peta | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations:launchTemplate:launchTemplateId | ID template peluncuran Amazon EC2 Fast Launch untuk gambar. | String | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations:launchTemplate:launchTemplateName | Nama template peluncuran Amazon EC2 Fast Launch untuk gambar. | String | Tidak | ||
| Konfigurasi:cepat LaunchConfigurations:launchTemplate:launchTemplateVersion | Versi template peluncuran Amazon EC2 Fast Launch untuk gambar. | String | Tidak | ||
| Konfigurasi:ssm ParameterConfigurations | Konfigurasi parameter Manajer Sistem untuk gambar. | Peta | Tidak | ||
| Konfigurasi:ssm ParameterConfigurations:amiAccountId | Parameter System Manager ID akun AMI untuk gambar. | String | Tidak | ||
| Konfigurasi:ssm ParameterConfigurations:parameterName | Nama parameter Manajer Sistem untuk gambar. | String | Ya jika ssmParameterConfigurations ditentukan |
||
| Konfigurasi:ssm ParameterConfigurations:dataType | Jenis data parameter Manajer Sistem untuk gambar. | String | Tidak | Nilai yang diizinkan - text|aws:ec2:image) |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| KonfigurasiDimages | Daftar gambar yang dikonfigurasi. | Array |
| dikonfigurasi Images:accountId | ID akun tujuan dari gambar yang didistribusikan. | String |
| dikonfigurasi Images:name | Nama AMI. | String |
| dikonfigurasi Images:amiId | ID AMI dari gambar yang didistribusikan. | String |
| dikonfigurasi Images:dateStarted | Waktu UTC saat distribusi dimulai. | String |
| dikonfigurasi Images:dateStopped | Waktu UTC saat distribusi selesai. | String |
| dikonfigurasi Images:step | Langkah di mana distribusi berhenti. | Selesai| AssociateLicensesRunning | | UpdateLaunchTemplateRunning | PutSsmParametersRunning | UpdateFastLaunchConfiguration ExportAmiQueued ExportAmiRunning |
| dikonfigurasi Images:region | Wil AWS ayah gambar yang didistribusikan. | String |
| dikonfigurasi Images:status | Status distribusi. | Selesai|Gagal|Dibatal| TimedOut |
| dikonfigurasi Images:errorMessage | Pesan kesalahan, jika ada. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:ApplyImageConfigurationsaction: ApplyImageConfigurations onFailure: Abort inputs: distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages configurations: - region:us-west-2licenseConfigurationArns: - arn:aws:license-manager:us-west-2:111122223333:license-configuration:lic-example
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.ApplyImageConfigurationsStep.configuredImages
BootstrapInstanceForContainer
Tindakan langkah ini menjalankan skrip layanan untuk mem-bootstrap instance dengan persyaratan minimum untuk menjalankan alur kerja kontainer. Image Builder menggunakan API Manajer Sistem untuk menjalankan skrip ini. sendCommand Untuk informasi selengkapnya, lihat J AWS Systems Manager alankan Perintah.
catatan
Skrip bootstrap menginstal paket AWS CLI dan Docker yang merupakan prasyarat agar Image Builder berhasil membangun wadah Docker. Jika Anda tidak menyertakan tindakan langkah ini, pembuatan gambar bisa gagal.
Batas Waktu Default: 60 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance untuk bootstrap. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| lari CommandId | ID Manajer Sistem sendCommand yang menjalankan skrip bootstrap pada instance. | String |
| status | Status dikembalikan dari Manajer SistemsendCommand. | String |
| output | Output dikembalikan dari Manajer SistemsendCommand. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:ContainerBootstrapStepaction: BootstrapInstanceForContainer onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.ContainerBootstrapStep.status
CollectImageMetadata
Tindakan langkah ini hanya berlaku untuk alur kerja build.
EC2 Image Builder menjalankan Agen AWS Systems Manager (Manajer Sistem) pada instans EC2 yang diluncurkan untuk membangun dan menguji gambar Anda. Image Builder mengumpulkan informasi tambahan tentang instance yang digunakan selama fase build dengan System Manager Inventory. Informasi ini mencakup nama dan versi sistem operasi (OS), serta daftar paket dan versi masing-masing seperti yang dilaporkan oleh sistem operasi Anda.
catatan
Tindakan langkah ini hanya berfungsi untuk gambar yang membuat AMI.
Batas Waktu Default: 30 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Image Builder mengembalikan semua sumber daya Manajer Sistem yang dibuat selama langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | Instance build untuk menerapkan pengaturan metadata. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance build untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| osVersion | Nama dan versi sistem operasi dikumpulkan dari instance build. | String |
| ID Asosiasi | ID asosiasi Manajer Sistem yang digunakan untuk pengumpulan inventaris. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:CollectMetadataStepaction: CollectImageMetadata onFailure: Abort inputs: instanceId: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.CollectMetadataStep.osVersion
CollectImageScanFindings
Jika Amazon Inspector diaktifkan untuk akun Anda dan pemindaian gambar diaktifkan untuk pipeline Anda, tindakan langkah ini mengumpulkan temuan pemindaian gambar yang dilaporkan oleh Amazon Inspector untuk instance pengujian Anda. Tindakan langkah ini tidak tersedia untuk alur kerja build.
Batas Waktu Default: 120 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID untuk instance yang dijalankan pemindaian. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| lari CommandId | ID Manajer Sistem sendCommand yang menjalankan skrip untuk mengumpulkan temuan. | String |
| status | Status dikembalikan dari Manajer SistemsendCommand. | String |
| output | Output dikembalikan dari Manajer SistemsendCommand. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:CollectFindingsStepaction: CollectImageScanFindings onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.CollectFindingsStep.status
CreateImage
Tindakan langkah ini membuat gambar dari instance yang sedang berjalan dengan Amazon EC2 CreateImage API. Selama proses pembuatan, tindakan langkah menunggu seperlunya untuk memverifikasi bahwa sumber daya telah mencapai status yang benar sebelum dilanjutkan.
Batas Waktu Standar: 720 menit
Waktu Batas Maks: 3 hari (259.200 detik)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Masukan: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | Contoh untuk membuat gambar baru. | Tali | Ya | Instans untuk ID instance yang disediakan harus dalam running status saat langkah ini dimulai. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| imageId | ID AMI dari gambar yang dibuat. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:CreateImageFromInstanceaction: CreateImage onFailure: Abort inputs: instanceId.$: "i-1234567890abcdef0"
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.CreateImageFromInstance.imageId
CreateImageFromIso
Gunakan tindakan langkah ini untuk membuat Amazon Machine Image (AMI) dari image disk ISO pada instance build. Gunakan dalam alur kerja build ketika sumber Anda adalah file ISO daripada AMI dasar. Image Builder mengonversi ISO ke AMI dan menunggu sumber daya mencapai status yang diperlukan sebelum dilanjutkan.
catatan
Tindakan ini memiliki persyaratan yang sama dengan mengimpor image disk ISO. Untuk informasi selengkapnya, lihat Impor image disk Windows ISO terverifikasi dengan Image Builder.
Batas Waktu Standar: 720 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Masukan: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance build yang menyimpan citra disk ISO. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance build untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| Amin Name | Nama AMI yang dibuat langkah tersebut. | String |
| Snapshot ID | ID snapshot yang mendukung AMI. | String |
| arsitektur | Arsitektur AMI (x86_64atauarm64). |
String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:CreateImageFromIsoStepaction: CreateImageFromIso onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.CreateImageFromIsoStep.amiName
DistributeContainerImage
Gunakan tindakan langkah ini untuk mendistribusikan image wadah yang dibuat tahap build ke repositori Amazon ECR di Wilayah target yang ditentukan untuk gambar. Gunakan tindakan ini dalam alur kerja distribusi untuk gambar container (DOCKER). Ini berfungsi sebagai mitra gambar wadah untuk. DistributeImage
Tindakan langkah ini menjalankan perintah Manajer Sistem pada instance build untuk mendorong image container. Instance harus memiliki Docker dan yang AWS CLI diinstal. Untuk informasi selengkapnya, lihat BootstrapInstanceForContainer.
penting
Alur kerja yang mencakup juga DistributeContainerImage tidak dapat menyer DistributeImage takanModifyImageAttributes,, atauApplyImageConfigurations. Sebuah alur kerja tunggal mendistribusikan gambar kontainer atau AMI, bukan keduanya.
Batas Waktu Default: 120 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Masukan: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance build yang menyimpan image container. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance build untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| status | Status dikembalikan dari Manajer SistemsendCommand. | String |
| BersuksesRegions | Daerah tempat distribusi berhasil. | Array |
| Wilayah yang Gagal | Wilayah di mana distribusi gagal. | Array |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:DistributeContaineraction: DistributeContainerImage onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.DistributeContainer.status
DistributeImage
Tindakan langkah ini mendistribusikan AMI ke Daerah target dan akun yang Anda tentukan. Ini menggunakan konfigurasi distribusi dari CreateImage atau CreateImagePipeline permintaan Anda, atau pengaturan distribusi kustom dalam alur kerja yang mengesampingkan konfigurasi default.
catatan
In distributions putnya opsional. Jika Anda menyediakannya, Image Builder menggunakan input alur kerja Anda dan mengabaikan konfigurasi distribusi terlampir. Jika Anda menghilangkannya, Image Builder kembali ke konfigurasi distribusi yang dilampirkan ke pipeline atau gambar.
Batas Waktu Default: 360 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Masukan: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| distribusi | Pengaturan distribusi untuk AMI, sebagai daftar. Setiap item menargetkan satu AWS Wilayah. Jika Anda menghilangkan input ini, Image Builder menggunakan konfigurasi distribusi yang dilampirkan ke pipeline atau gambar. | Array | Tidak | ||
| distribusi:wilayah | Wil AWS ayah untuk mendistribusikan AMI ke. | Tali | Ya | Panjang minimum 1. Panjang maksimum 1024. | |
| distribusi:nama | Nama yang akan diterapkan pada AMI yang didistribusikan. | String | Tidak | ||
| distribusi:deskripsi | Deskripsi untuk diterapkan pada AMI yang didistribusikan. | String | Tidak | ||
| distribusi:target AccountIds | ID akun untuk mendistribusikan AMI. | Array | Tidak | ||
| Distribusi: Amitags | Tag yang akan diterapkan pada AMI yang didistribusikan. | Peta | Tidak | Maksimal 50 tag. | |
| Distribusi: kms KeyId | Kunci KMS yang digunakan untuk mengenkripsi AMI terdistribusi. | String | Tidak |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| DistributorDimages | Daftar gambar yang didistribusikan | Array |
| didistribusikan Images:region | Wil AWS ayah gambar yang didistribusikan. | String |
| didistribusikan Images:name | Nama AMI. | String |
| didistribusikan Images:amiId | ID AMI dari gambar yang didistribusikan. | String |
| didistribusikan Images:accountId | ID akun tujuan dari gambar yang didistribusikan. | String |
| didistribusikan Images:dateStarted | Waktu UTC saat distribusi dimulai. | String |
| didistribusikan Images:dateStopped | Waktu UTC saat distribusi selesai. | String |
| didistribusikan Images:status | Status distribusi. | Selesai|Gagal|Dibatal| TimedOut |
| didistribusikan Images:step | Langkah di mana distribusi berhenti. | Selesai| CopyAmiRunning |
| didistribusikan Images:errorMessage | Pesan kesalahan, jika ada. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:DistributeImageaction: DistributeImage onFailure: Abort inputs: distributions: - region.$: "$.parameters.SourceRegion" description: "AMI distribution to source region" amiTags: DistributionTest: "SourceRegion" WorkflowStep: "DistributeToSourceRegion" BuildDate: "{{imagebuilder:buildDate:yyyyMMHHss}}" BuildVersion: "{{imagebuilder:buildVersion}}"
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.DistributeImageStep.distributedImages
ExecuteComponents
Tindakan langkah ini menjalankan komponen yang ditentukan dalam resep untuk gambar saat ini yang sedang dibangun. Alur kerja build menjalankan komponen build pada instance build. Alur kerja pengujian hanya menjalankan komponen pengujian pada instance pengujian.
Image Builder menggunakan API Manajer Sistem untuk menjalankan komponen. sendCommand Untuk informasi selengkapnya, lihat J AWS Systems Manager alankan Perintah.
Batas Waktu Standar: 720 menit
Waktu Batas Maks: 1 hari (24 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID untuk instance yang harus dijalankan komponen. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| lari CommandId | ID Manajer Sistem sendCommand yang menjalankan komponen pada instance. | String |
| status | Status dikembalikan dari Manajer SistemsendCommand. | String |
| output | Output dikembalikan dari Manajer SistemsendCommand. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:ExecComponentsStepaction: ExecuteComponents onFailure: Abort inputs: instanceId: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.ExecComponentsStep.status
ExecuteStateMachine
Tindakan langkah ini memulai eksekusi mesin AWS Step Functions status dari alur kerja Image Builder. Image Builder menggunakan Step Functions StartExecution API untuk memulai mesin status dan menunggu sampai selesai. Ini berguna untuk mengintegrasikan alur kerja yang kompleks, validasi kepatuhan, atau proses sertifikasi ke dalam pipeline pembuatan gambar Anda.
Untuk informasi selengkapnya, lihat Mem pelajari mesin status di Fungsi Langkah di Panduan AWS Step Functions Pengembang.
Batas Waktu Default: 6 jam
Waktu Batas Maks: 24 jam
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| negara MachineArn | ARN dari Step Functions state machine untuk dieksekusi. | Tali | Ya | Harus berupa mesin status ARN yang valid. | |
| input | Data input JSON untuk diberikan ke mesin status. | String | Tidak | {} | Harus berupa string JSON yang valid, panjang maksimum: 16 KiB. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| Eksekusi Arn | ARN dari eksekusi mesin negara. | String |
| output | Output dari eksekusi mesin negara. | String |
Diperlukan izin IAM
Peran eksekusi kustom Anda harus memiliki izin berikut untuk menggunakan tindakan langkah ini:
Izinkan tindakan
-
states:StartExecution -
states:DescribeExecution
Tentukan sumber daya
-
arn:aws:states:us-west-2:111122223333:stateMachine:state-machine-name -
arn:aws:states:us-west-2:111122223333:execution:state-machine-name:*
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:ValidateImageComplianceaction: ExecuteStateMachine timeoutSeconds: 3600 onFailure: Abort inputs: stateMachineArn: arn:aws:states:us-west-2:111122223333:stateMachine:ImageComplianceValidationinput: | { "imageId": "{{ $.stepOutputs.CreateImageFromInstance.imageId }}", "region": "us-west-2", "complianceLevel": "high", "requiredScans": ["cve", "benchmark", "configuration"] }
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.ValidateImageCompliance.executionArn
LaunchInstance
Gunakan tindakan langkah ini untuk meluncurkan instance di Anda Akun AWS. Tindakan menunggu hingga instance memenuhi kondisi pemeriksaan kesehatan yang ditentukan dan agen Manajer Sistem berjalan sebelum melanjutkan ke langkah berikutnya. Tindakan peluncuran menggunakan pengaturan dari sumber daya konfigurasi resep dan infrastruktur Anda. Misalnya, jenis instance yang akan diluncurkan berasal dari konfigurasi infrastruktur. Outputnya adalah ID instance dari instance yang diluncurkan.
In waitFor put mengonfigurasi kondisi yang memenuhi persyaratan penyelesaian langkah. In healthCheck put menentukan tingkat validasi kesehatan instans EC2 yang harus dilalui sebelum langkah dilanjutkan.
Batas Waktu Default: 75 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Untuk instans build, rollback melakukan tindakan yang telah Anda konfigurasikan di sumber daya konfigurasi infrastruktur. Secara default, instance build dihentikan jika pembuatan gambar gagal. Namun, ada pengaturan dalam konfigurasi infrastruktur untuk menjaga instance build untuk pemecahan masalah.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| gambar IdOverride | Gambar yang digunakan untuk meluncurkan instance | String | Tidak |
Tahap membangun: Gambar dasar resep gambar Tahap uji: Keluarkan AMI dari tahap build |
Harus memiliki ID AMI yang valid |
| contoh TypesOverride | Image Builder mencoba setiap jenis instance dalam daftar sampai menemukan satu yang berhasil diluncurkan | Daftar String | Tidak | Jenis instans yang ditentukan dalam Konfigurasi Infrastruktur Anda | Harus tipe instans yang valid |
| Tunggu Untuk | Kondisi untuk menunggu sebelum menyelesaikan langkah alur kerja dan melanjutkan ke langkah berikutnya | Tali | Ya | Tidak ada | Image Builder mendukungssmAgent. |
| Pemeriksaan Kesehatan | Tingkat validasi kesehatan EC2 yang diperlukan sebelum langkah alur kerja berlanjut. T RUNNING entukan build yang lebih cepat dengan validasi minimal, atau STATUS_CHECK_PASSED menunggu pemeriksaan status EC2 lulus. |
String | Tidak | STATUS_CHECK_PASSED |
Nilai yang valid: RUNNING | STATUS_CHECK_PASSED. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| instanceId | ID instance dari instance yang diluncurkan. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:LaunchStepaction: LaunchInstance onFailure: Abort inputs: healthCheck: "RUNNING" waitFor:ssmAgent
Gunakan output dari tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.LaunchStep.instanceId
ModifyImageAttributes
Gunakan tindakan langkah ini untuk memodifikasi atribut AMI terdistribusi, seperti izin peluncuran dan atribut AMI lainnya. Ini beroperasi pada AMI yang telah didistribusikan ke Daerah dan akun target.
catatan
In attributes putnya opsional. Jika Anda menyediakannya, Image Builder menggunakan input alur kerja Anda dan mengabaikan konfigurasi distribusi terlampir. Jika Anda menghilangkannya, Image Builder kembali ke konfigurasi distribusi yang dilampirkan ke pipeline atau gambar.
Batas Waktu Default: 120 menit
Waktu Batas Maks: 180 menit (3 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Masukan: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| DistributorDimages. $ | Daftar gambar yang didistribusikan untuk dimodifikasi. Referensi distributedImages kan output dari DistributeImage langkah dalam alur kerja yang sama. |
Tali | Ya | Referensi JSONPath yang dimulai dengan $.stepOutputs. |
|
| atribut | Atribut gambar untuk memodifikasi, sebagai daftar. Setiap item menargetkan satu AWS Wilayah. | Array | Tidak | ||
| atribut:wilayah | Wil AWS ayah AMI yang didistribusikan untuk dimodifikasi. | Tali | Ya | Diperlukan untuk setiap item diattributes. |
|
| atribut:LaunchPermission | Pengaturan izin peluncuran untuk diterapkan ke AMI yang didistribusikan. | Peta | Tidak | ||
| atribut:peluncuran Permission:userIds | ID akun untuk ditambahkan atau dihapus dari izin peluncuran untuk AMI. | Array | Tidak | ||
| atribut:peluncuran Permission:userGroups | Grup pengguna yang akan ditambahkan atau dihapus dari izin peluncuran untuk AMI. | Array | Tidak | ||
| atribut:peluncuran Permission:organizationArns | ARN AWS Organisasi untuk ditambahkan atau dihapus dari izin peluncuran untuk AMI. | Array | Tidak | ||
| atribut:peluncuran Permission:organizationalUnitArns | ARN unit organisasi (OU) untuk ditambahkan atau dihapus dari izin peluncuran untuk AMI. | Array | Tidak |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| ModifikasiDimages | Daftar gambar yang dimodifikasi | Array |
| dimodifikasi Images:accountId | ID akun tujuan dari gambar yang didistribusikan. | String |
| dimodifikasi Images:name | Nama AMI. | String |
| dimodifikasi Images:amiId | ID AMI dari gambar yang didistribusikan. | String |
| dimodifikasi Images:dateStarted | Waktu UTC saat distribusi dimulai. | String |
| dimodifikasi Images:dateStopped | Waktu UTC saat distribusi selesai. | String |
| dimodifikasi Images:step | Langkah di mana distribusi berhenti. | Selesai| ModifyAmiRunning |
| dimodifikasi Images:region | AWS Wilayah gambar. | String |
| dimodifikasi Images:status | Status distribusi. | Selesai|Gagal|Dibatal| TimedOut |
| dimodifikasi Images:errorMessage | Pesan kesalahan, jika ada. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:ModifyImageAttributesaction: ModifyImageAttributes onFailure: Abort inputs: distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages attributes: - region:us-west-2launchPermission: userIds: - "111122223333"
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.ModifyImageAttributesStep.modifiedImages
RegisterImage
Tindakan langkah ini mendaftarkan Amazon Machine Image (AMI) baru menggunakan Amazon EC2 RegisterImage API. Ini memungkinkan Anda untuk membuat AMI dari snapshot yang ada atau set snapshot, menentukan berbagai atribut gambar.
Batas Waktu Standar: 540 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Masukan: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| arsitektur | Arsitektur AMI. | String | Tidak | Nilai yang valid: i386, x86_64, arm64, x86_64_mac, arm64_mac | |
| blok DeviceMapping | Entri pemetaan perangkat blok untuk AMI. | Array | Tidak | ||
| BootMode | Mode boot AMI. | String | Tidak | Nilai yang valid: legacy-bios, uefi, uefi- | |
| deskripsi | Deskripsi untuk AMI. | String | Tidak | ||
| ENASupport | Apakah jaringan yang disempurnakan dengan ENA diaktifkan. | Boolean | Tidak | ||
| GambarLokasi | Lokasi manifes AMI. | String | Tidak | Diperlukan untuk S3-backed AMI | |
| Dukungan IMDS | Tingkat dukungan IMDSv2. | String | Tidak | Nilai yang valid: v2.0 | |
| termasuk SnapshotTags | Apakah akan menyertakan tag dari snapshot pertama yang ditentukan dalam pemetaan perangkat blok. | Boolean | Tidak | SALAH |
Ketika disetel ke true, tag disertakan sebagai berikut:
|
| KerneID | ID kernel yang akan digunakan. | String | Tidak | ||
| RamdisKid | ID disk RAM yang akan digunakan. | String | Tidak | ||
| akar DeviceName | Nama perangkat perangkat root. | String | Tidak | Contoh:/dev/sda1 | |
| srion NetSupport | Jaringan yang ditingkatkan dengan antarmuka Intel 82599 VF. | String | Tidak | ||
| Dukungan TPM | Dukungan versi TPM. | String | Tidak | Nilai yang valid: v2.0 | |
| UEFIdata | Base64-encoded Data UEFI. | String | Tidak | ||
| Jenis Virtualisasi | Jenis virtualisasi. | String | Tidak | Nilai yang valid: hvm, paravirtual |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| imageId | ID AMI dari gambar terdaftar. | String |
Diperlukan izin IAM
Peran eksekusi kustom Anda harus memiliki izin berikut untuk menggunakan tindakan langkah ini:
Izinkan tindakan
-
ec2:DescribeSnapshots -
ec2:CreateTags
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name: RegisterNewImage action: RegisterImage onFailure: Abort inputs: architecture: "x86_64" bootMode: "uefi" blockDeviceMapping: - DeviceName: "/dev/sda1" Ebs: SnapshotId: "snap-1234567890abcdef0" VolumeSize: 100 VolumeType: "gp3" rootDeviceName: "/dev/sda1" virtualizationType: "hvm"
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.RegisterNewImage.imageId
Contoh dengan tag SnapshotId dari langkah lain dan snapshot yang disertakan dalam AMI yang dihasilkan
- name: CreateSnapshot action: RunCommand onFailure: Abort inputs: instanceId: "i-1234567890abcdef0" documentName: "AWS-RunShellScript" parameters: commands: - "aws ec2 create-snapshot --volume-idvol-1234567890abcdef0--description 'Snapshot for AMI' --query 'SnapshotId' --output text" - name: RegisterImageFromSnapshot action: RegisterImage onFailure: Abort inputs: architecture: "x86_64" bootMode: "uefi" blockDeviceMapping: - DeviceName: "/dev/sda1" Ebs: SnapshotId.$: "$.stepOutputs.CreateSnapshot.output[0]" VolumeSize: 100 VolumeType: "gp3" includeSnapshotTags: true rootDeviceName: "/dev/sda1" virtualizationType: "hvm"
RunCommand
Tindakan langkah ini menjalankan dokumen perintah untuk alur kerja Anda. Image Builder menggunakan API Manajer Sistem untuk menjalankannya untuk Anda. sendCommand Untuk informasi selengkapnya, lihat J AWS Systems Manager alankan Perintah.
Batas Waktu Standar: 720 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance untuk menjalankan dokumen perintah. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance untuk alur kerja ini. | |
| documentName | Nama dokumen perintah Manajer Sistem untuk dijalankan. | Tali | Ya | ||
| parameter | Daftar pasangan nilai kunci untuk parameter apa pun yang diperlukan dokumen perintah. | <string>kamus <string, daftar > | Bersyarat | ||
| Versi Dokumen | Versi dokumen perintah untuk dijalankan. | String | Tidak | $DEFAULT |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| lari CommandId | ID Manajer Sistem sendCommand yang menjalankan dokumen perintah pada instance. | String |
| status | Status dikembalikan dari Manajer SistemsendCommand. | String |
| output | Output dikembalikan dari Manajer SistemsendCommand. | Daftar string |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:RunCommandDocaction: RunCommand onFailure: Abort inputs: documentName:SampleDocumentparameters: osPlatform: - "linux" instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.RunCommandDoc.status
RunSysPrep
Tindakan langkah ini menggunakan API Manajer Sistem untuk menjalankan AWSEC2-RunSysprep dokumen untuk instans Windows sebelum instance build dimatikan untuk snapshot. sendCommand Tindakan ini mengikuti praktik AWS terbaik untuk pengerasan dan pembersihan gambar
Batas Waktu Default: 60 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance untuk menjalankan AWSEC2-RunSysprep dokumen. |
Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| lari CommandId | ID Manajer Sistem sendCommand yang menjalankan AWSEC2-RunSysprep dokumen pada instance. |
String |
| status | Status dikembalikan dari Manajer SistemsendCommand. | String |
| output | Output dikembalikan dari Manajer SistemsendCommand. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:RunSysprepaction: RunSysPrep onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.RunSysprep.status
SanitizeInstance
Tindakan langkah ini menjalankan skrip sanitasi yang direkomendasikan untuk instans Linux sebelum instance build dimatikan untuk snapshot. Skrip sanitize membantu memastikan bahwa gambar akhir mengikuti praktik terbaik keamanan, dan artefak atau pengaturan build yang tidak boleh dibawa ke snapshot Anda dihapus. Untuk informasi selengkapnya tentang skrip, lihatDiperlukan pembersihan pasca pembangunan. Tindakan langkah ini tidak berlaku untuk gambar kontainer.
Image Builder menggunakan API Manajer Sistem untuk menjalankan skrip ini. sendCommand Untuk informasi selengkapnya, lihat J AWS Systems Manager alankan Perintah.
Batas Waktu Default: 60 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance yang akan dibersihkan. | Tali | Ya | Ini harus menjadi ID instance keluaran dari langkah alur kerja yang meluncurkan instance untuk alur kerja ini. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| lari CommandId | ID Manajer Sistem sendCommand yang menjalankan skrip sanitize pada instance. | String |
| status | Status dikembalikan dari Manajer SistemsendCommand. | String |
| output | Output dikembalikan dari Manajer SistemsendCommand. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:SanitizeStepaction: SanitizeInstance onFailure: Abort inputs: instanceId: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.SanitizeStep.status
TerminateInstance
Tindakan langkah ini mengakhiri instance yang Anda tentukan dengan instanceId input. Secara default, ini memulai penghentian dan pindah ke langkah berikutnya tanpa menunggu. Proses latar belakang menangani pembersihan jika penghentian menemukan kesalahan layanan EC2. Untuk menunggu penghentian penuh sebelum melanjutkan, atur waitForTermination input ketrue.
Batas Waktu Default: 30 menit
Waktu Batas Maks: 720 menit (12 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance yang akan dihentikan. | Tali | Ya | Tidak ada | Tidak ada |
| tunggu ForTermination | Menentukan apakah langkah menunggu instance mencapai status yang dihentikan sebelum melanjutkan. Saat diatur ketrue, langkah menunggu penghentian penuh (10 detik hingga beberapa menit). |
Boolean | Tidak | false |
true | false |
Output: Tidak ada output untuk tindakan langkah ini.
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:TerminateInstanceaction: TerminateInstance onFailure: Continue inputs: instanceId.$:i-1234567890abcdef0waitForTermination:false
WaitForAction
Tindakan langkah ini menjeda alur kerja yang sedang berjalan dan menunggu untuk menerima tindakan eksternal dari tindakan SendWorkflowStepAction API Pembuat Gambar. Langkah ini menerbitkan EventBridge acara ke bus EventBridge acara default Anda dengan tipe detailEC2 Image Builder Workflow Step Waiting. Langkah ini juga dapat mengirim pemberitahuan SNS jika Anda memberikan ARN Topik SNS, atau memanggil fungsi Lambda secara asinkron jika Anda memberikan nama fungsi Lambda.
Bagaimana jeda dan resume bekerja
Saat WaitForAction langkah berjalan, Image Builder menetapkan status langkah ke WAITING dan menerbitkan EventBridge peristiwa (tipe detailEC2 Image Builder Workflow Step Waiting). Jika Anda memberikansnsTopicArn, itu juga mengirimkan pemberitahuan Amazon SNS. Jika Anda menyediakanlambdaFunctionName, itu memanggil fungsi itu secara asinkron. Alur kerja tetap dijeda sampai salah satu hal berikut terjadi:
-
Anda memanggil SendWorkflowStepAction dengan
RESUMEuntuk melanjutkan, atauSTOPuntuk mengakhiri alur kerja. -
Langkah mencapai batas waktu (default 3 hari, maksimum 7 hari), dan alur kerja gagal.
reasonYang Anda lewati SendWorkflowStepAction disimpan dengan langkah dan tersedia untuk langkah-langkah selanjutnya sebagai reason output langkah.
Batas Waktu Default: 3 hari
Waktu Batas Maks: 7 hari (604.800 detik)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| sns TopicArn | Topik SNS opsional ARN untuk mengirim pemberitahuan ketika langkah alur kerja tertunda. | String | Tidak | ||
| Lambda FunctionName | Nama opsional atau ARN fungsi Lambda untuk dipanggil secara asinkron saat langkah alur kerja tertunda. | String | Tidak | ||
| payload | String JSON digunakan sebagai pesan untuk SNS dan payload untuk Lambda. Jika disediakan, payload khusus dibungkus secara default message/payload, digunakan untuk SNS dan Lambda masing-masing. Jika tidak disediakan, menghasilkan default message/payload. | String | Tidak | Harus berupa string JSON yang valid, maks 16 KiB |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| tindakan | Tindakan yang dikem SendWorkflowStepAction balikan oleh tindakan API. | String (RESUMEatauSTOP) |
| akal budi | Alasan untuk tindakan yang dikembalikan. | String |
Diperlukan izin IAM
Peran eksekusi kustom Anda harus memiliki izin berikut untuk menggunakan tindakan langkah ini:
Izinkan tindakan
-
lambda:InvokeFunction
Tentukan sumber daya
-
arn:aws:lambda:us-west-2:111122223333:function:function-name -
arn:aws:lambda:us-west-2:111122223333:function:*
Contoh
Tentukan tindakan langkah dalam dokumen alur kerja dengan notifikasi SNS.
- name:SendEventAndWaitaction: WaitForAction onFailure: Abort inputs: snsTopicArn: arn:aws:sns:us-west-2:111122223333:ExampleTopic
Tentukan tindakan langkah dalam dokumen alur kerja dengan pemanggilan fungsi Lambda.
- name:SendEventAndWaitWithLambdaaction: WaitForAction onFailure: Abort inputs: lambdaFunctionName:ExampleFunctionpayload: | { "imageId": "{{ $.stepOutputs.CreateImageFromInstance.imageId }}", "region": "us-west-2" }
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.SendEventAndWait.reason
WaitForSSMAgent
Tindakan langkah ini menunggu instans EC2 dapat dikelola AWS Systems Manager setelah periode tidak responsif yang diharapkan. Ini sangat berharga untuk alur kerja dengan gangguan instans yang diketahui, seperti reboot sistem, peningkatan OS, atau operasi khusus platform yang memutuskan sementara instance dari SSM. Image Builder memantau instance hingga mendapatkan kembali konektivitas SSM atau waktu habis.
Batas Waktu Default: 60 menit
Waktu Batas Maks: 180 menit (3 jam)
Anda dapat mengganti default dengantimeoutSeconds, hingga maksimum yang ditampilkan. Nilai di atas maksimum gagal validasi.
Rollback: Tidak ada rollback untuk tindakan langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | ID instance yang akan dipantau untuk konektivitas SSM. | Tali | Ya | Harus berupa ID instans EC2 yang valid |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| status | Status koneksi Agen SSM. | String |
Contoh
Tentukan langkah tindakan dalam dokumen alur kerja.
- name:WaitForInstanceAfterRebootaction: WaitForSSMAgent onFailure: Abort timeoutSeconds: 900 inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.WaitForInstanceAfterReboot.status