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 Image Builder.
Istilah yang digunakan dalam bagian ini
- AMI
-
Gambar Mesin Amazon
- ARN
-
Nama Sumber Daya Amazon
Tindakan yang didukung
ApplyImageConfigurations
Tindakan langkah ini menerapkan berbagai konfigurasi dan integrasi untuk didistribusikan AMIs, seperti konfigurasi lisensi, konfigurasi template peluncuran, konfigurasi ekspor S3, konfigurasi EC2 Fast Launch, dan konfigurasi parameter Systems Manager. Konfigurasi berlaku untuk gambar terdistribusi hanya di akun sumber, kecuali untuk konfigurasi parameter SSM yang dapat diterapkan lintas akun.
Batas Waktu Default: 360 menit
Batas Waktu Maks: 720 menit
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 |
|---|---|---|---|---|---|
| region | Wilayah gambar. | Tali | Ya | ||
| licenseConfigurationArns | Konfigurasi lisensi ARN untuk gambar. | Array | Tidak | ||
| launchTemplateConfigurations | Array | Tidak | |||
| launchTemplateConfigurations:launchTemplateId | ID template peluncuran untuk diterapkan ke gambar. | String | Ya jika launchTemplateConfigurations ditentukan |
||
| launchTemplateConfigurations:AccountID | Akun template peluncuran IDs untuk diterapkan ke gambar. | String | Tidak | ||
| launchTemplateConfigurations:setDefaultVersion | Pengaturan versi default template peluncuran untuk gambar. | Boolean | Tidak | ||
| s3 ExportConfiguration | Array | Tidak | |||
| ExportConfigurationS3: RoleName | Nama peran konfigurasi ekspor S3 untuk gambar. | String | Ya jika s3ExportConfiguration ditentukan |
||
| s3ExportConfiguration: diskImageFormat | Format gambar disk konfigurasi ekspor S3 untuk gambar. | String | Ya jika s3ExportConfiguration ditentukan |
Nilai yang diizinkan - VMDK|RAW|VHD | |
| S3: s3Bucket ExportConfiguration | Nama bucket konfigurasi ekspor S3 untuk gambar. | String | Ya jika s3ExportConfiguration ditentukan |
||
| S3: s3Awalan ExportConfiguration | Awalan bucket konfigurasi ekspor S3 untuk gambar. | String | Tidak | ||
| fastLaunchConfigurations | Konfigurasi Peluncuran EC2 Cepat untuk gambar. | Array | Tidak | ||
| fastLaunchConfigurations:diaktifkan | EC2 Peluncuran Cepat enabled/disabled untuk gambar. | Boolean | Ya jika fastLaunchConfigurations ditentukan |
||
| fastLaunchConfigurations:SnapshotKonfigurasi | EC2 Peluncuran Cepat enabled/disabled untuk gambar. | Peta | Tidak | ||
| fastLaunchConfigurations:SnapshotConfiguration: targetResourceCount | EC2 Peluncuran cepat jumlah sumber daya target untuk gambar. | Bilangan Bulat | Tidak | ||
| fastLaunchConfigurations:maxParallelLaunches | EC2 Peluncuran paralel maksimum peluncuran Fast Launch untuk gambar. | Bilangan Bulat | Tidak | ||
| fastLaunchConfigurations:LaunchTemplate | Tidak | ||||
| fastLaunchConfigurations:LaunchTemplate: launchTemplateId | EC2 ID template peluncuran Peluncuran Cepat untuk gambar. | String | Tidak | ||
| fastLaunchConfigurations:LaunchTemplate: launchTemplateName | EC2 Fast Launch meluncurkan nama template untuk gambar. | String | Tidak | ||
| fastLaunchConfigurations:LaunchTemplate: launchTemplateVersion | EC2 Versi template peluncuran Peluncuran Cepat untuk gambar. | String | Tidak | ||
| ssmParameterConfigurations | Konfigurasi Parameter SSM untuk gambar. | Peta | Tidak | ||
| ssmParameterConfigurations:amiAccountId | ID akun AMI Parameter SSM untuk gambar. | String | Tidak | ||
| ssmParameterConfigurations:Parametername | Nama Parameter SSM untuk gambar. | String | Ya jika ssmParameterConfigurations ditentukan |
||
| ssmParameterConfigurations:Jenis data | Jenis data Parameter SSM untuk gambar. | String | Tidak | Nilai yang diizinkan - text|aws:ec2:image) |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| ConfiguradImages | Daftar gambar yang dikonfigurasi. | Array |
| ConfiguradImages: AccountID | ID akun tujuan dari gambar yang didistribusikan. | String |
| ConfigureDimages:nama | Nama AMI. | String |
| ConfigureDimages:amiID | ID AMI dari gambar yang didistribusikan. | String |
| ConfigureDimages:DateStarted | Waktu UTC saat distribusi dimulai. | String |
| ConfigureDimags:DateSopped | Waktu UTC ketika distribusi selesai. | String |
| ConfiguradImages: Langkah | Langkah di mana distribusi berhenti. | Selesai| | | AssociateLicensesRunning | UpdateLaunchTemplateRunning | PutSsmParametersRunning UpdateFastLaunchConfiguration ExportAmiQueued ExportAmiRunning |
| ConfigureDimages:wilayah | Tne AWS dari gambar yang didistribusikan | String |
| ConfiguradImages: Status | Status distribusi. | Selesai|Gagal | Dibatalkan| TimedOut |
| ConfigureDimages:ErrorMessage | Pesan kesalahan, jika ada. | String |
Contoh
Tentukan tindakan langkah dalam dokumen alur kerja.
- name:ApplyImageConfigurationsaction: ApplyImageConfigurations onFailure: Abort inputs: distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages
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 Systems Manager untuk menjalankan skrip ini. sendCommand Untuk informasi selengkapnya, lihat AWS Systems Manager Menjalankan Perintah.
catatan
Skrip bootstrap menginstal paket AWS CLI dan Docker yang merupakan prasyarat bagi Image Builder agar berhasil membangun wadah Docker. Jika Anda tidak menyertakan tindakan langkah ini, pembuatan gambar bisa gagal.
Batas Waktu Default: 60 menit
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 dari instance untuk bootstrap. | Tali | Ya | Ini harus berupa 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 |
|---|---|---|
| runCommandId | ID Systems Manager sendCommand yang menjalankan skrip bootstrap pada instance. | String |
| status | Status dikembalikan dari Systems ManagersendCommand. | String |
| output | Output dikembalikan dari Systems ManagersendCommand. | String |
Contoh
Tentukan tindakan langkah 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 (Systems Manager) pada EC2 instance yang diluncurkan untuk membangun dan menguji gambar Anda. Image Builder mengumpulkan informasi tambahan tentang instance yang digunakan selama fase build dengan Systems Manager Inventory. Informasi ini mencakup nama dan versi sistem operasi (OS), serta daftar paket dan versinya masing-masing seperti yang dilaporkan oleh sistem operasi Anda.
catatan
Tindakan langkah ini hanya berfungsi untuk gambar yang dibuat AMIs.
Batas Waktu Default: 30 menit
Rollback: Image Builder mengembalikan semua sumber daya Systems Manager yang dibuat selama langkah ini.
Input: Tabel berikut mencakup input yang didukung untuk tindakan langkah ini.
| Nama masukan | Deskripsi | Tipe | Diperlukan | Default | Batasan |
|---|---|---|---|---|---|
| instanceId | Instans build untuk menerapkan pengaturan metadata ke. | Tali | Ya | Ini harus berupa 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 yang dikumpulkan dari instance build. | String |
| AssociationID | ID asosiasi Systems Manager yang digunakan untuk pengumpulan inventaris. | String |
Contoh
Tentukan tindakan langkah 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
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 contoh pemindaian berjalan. | Tali | Ya | Ini harus berupa 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 |
|---|---|---|
| runCommandId | ID Systems Manager sendCommand yang menjalankan skrip untuk mengumpulkan temuan. | String |
| status | Status dikembalikan dari Systems ManagersendCommand. | String |
| output | Output dikembalikan dari Systems ManagersendCommand. | String |
Contoh
Tentukan tindakan langkah 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 keadaan yang benar sebelum dilanjutkan.
Batas Waktu Default: 720 menit
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 | Contoh untuk membuat gambar baru dari. | Tali | Ya | Instance untuk ID instance yang disediakan harus dalam running keadaan 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 tindakan langkah 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
DistributeImage
Tindakan langkah ini mendistribusikan AMI ke wilayah dan akun tertentu. Ini membuat salinan AMI di wilayah target dan akun berdasarkan konfigurasi distribusi yang disediakan yang diberikan dalam permintaan untuk CreateImage atau CreateImagePipeline APIs atau pengaturan distribusi khusus yang disediakan dalam alur kerja untuk mengganti pengaturan dalam konfigurasi distribusi.
Batas Waktu Default: 360 menit
Batas Waktu Maks: 720 menit
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 |
|---|---|---|---|---|---|
| region | Daftar wilayah untuk mendistribusikan gambar. | Tali | Ya | Panjang minimum 1. Panjang maksimum 1024. | |
| name | Nama konfigurasi distribusi. | String | Tidak | ||
| deskripsi | Distribusi konfigurasi distribusi. | String | Tidak | ||
| targetAccountIds | Akun IDs untuk mendistribusikan gambar. | Array | Tidak | ||
| AmiTags | Tag konfigurasi distribusi. | Peta | Tidak | ||
| kmsKeyId | Kunci KMS untuk diterapkan pada gambar yang didistribusikan. | String | Tidak |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| DidistribusikanDimages | Daftar gambar yang didistribusikan | Array |
| Didistribusikan: Wilayah | AWS Wilayah Tne dari gambar yang didistribusikan. | String |
| DistributedImages:nama | Nama AMI. | String |
| Didistribusikan:Amiid | ID AMI dari gambar yang didistribusikan. | String |
| Didistribusikan:Accountid | ID akun tujuan dari gambar yang didistribusikan. | String |
| Didistribusikan: DateStarted | Waktu UTC saat distribusi dimulai. | String |
| Didistribusikan:DateSopped | Waktu UTC ketika distribusi selesai. | String |
| Didistribusikan:Status | Status distribusi. | Selesai|Gagal | Dibatalkan| TimedOut |
| Didistribusikan:Langkah | Langkah di mana distribusi berhenti. | Selesai| CopyAmiRunning |
| DistributedImages:ErrorMessage | Pesan kesalahan, jika ada. | String |
Contoh
Tentukan tindakan langkah 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 Systems Manager untuk menjalankan komponen. sendCommand Untuk informasi selengkapnya, lihat AWS Systems Manager Menjalankan Perintah.
Batas Waktu Default: 720 menit
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 contoh bahwa komponen harus berjalan. | Tali | Ya | Ini harus berupa 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 |
|---|---|---|
| runCommandId | ID Systems Manager sendCommand yang menjalankan komponen pada instance. | String |
| status | Status dikembalikan dari Systems ManagersendCommand. | String |
| output | Output dikembalikan dari Systems ManagersendCommand. | String |
Contoh
Tentukan tindakan langkah 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 state machine 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 Pelajari tentang mesin status di Step Functions di Panduan AWS Step Functions Pengembang.
Batas Waktu Default: 6 jam
Batas Waktu Maks: 24 jam
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 |
|---|---|---|---|---|---|
| stateMachineArn | ARN dari mesin status Step Functions yang akan dijalankan. | Tali | Ya | Harus berupa ARN mesin negara yang valid. | |
| input | Data input JSON untuk diberikan ke mesin negara. | String | Tidak | {} | Harus string JSON yang valid, panjang maksimum: 16 KiB. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| ExecutionARN | ARN dari eksekusi mesin negara. | String |
Izin IAM diperlukan
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 tindakan langkah 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
Tindakan langkah ini meluncurkan instance di Anda Akun AWS dan menunggu hingga agen Systems Manager berjalan pada instance sebelum melanjutkan ke langkah berikutnya. Tindakan peluncuran menggunakan pengaturan dari sumber daya konfigurasi resep dan infrastruktur yang terkait dengan gambar Anda. Misalnya, jenis instance yang akan diluncurkan berasal dari konfigurasi infrastruktur. Outputnya adalah ID instance dari instance yang diluncurkan.
waitForInput mengkonfigurasi kondisi yang memenuhi persyaratan penyelesaian langkah.
Batas Waktu Default: 60 menit
Rollback: Untuk instance build, rollback melakukan tindakan yang telah dikonfigurasi 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 |
|---|---|---|---|---|---|
| imageIdOverride | Gambar yang akan digunakan untuk meluncurkan instance | String | Tidak |
Membangun panggung: Gambar dasar resep gambar Tahap pengujian: Output AMI dari tahap build |
Harus berupa ID AMI yang valid |
| instanceTypesOverride | Image Builder mencoba setiap jenis instance dalam daftar hingga menemukan satu yang berhasil diluncurkan | Daftar String | Tidak | Jenis instans yang ditentukan dalam Konfigurasi Infrastruktur | Harus jenis instance yang valid |
| Menunggu | Kondisi untuk menunggu sebelum menyelesaikan langkah alur kerja dan melanjutkan ke langkah berikutnya | Tali | Ya | Image Builder mendukungssmAgent. |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| instanceId | ID instance dari instance yang diluncurkan. | String |
Contoh
Tentukan tindakan langkah dalam dokumen alur kerja.
- name:LaunchStepaction: LaunchInstance onFailure: Abort inputs: waitFor:ssmAgent
Gunakan output dari tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.LaunchStep.instanceId
ModifyImageAttributes
Tindakan langkah ini memodifikasi atribut terdistribusi AMIs, seperti izin peluncuran dan atribut AMI lainnya. Ini beroperasi pada AMIs yang telah didistribusikan ke wilayah target dan akun.
Batas Waktu Default: 120 menit
Batas Waktu Maks: 180 menit
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 |
|---|---|---|---|---|---|
| region | Wilayah gambar. | Tali | Ya | ||
| LaunchPermission | Tidak | ||||
| LaunchPermission: UserIds | Pengguna IDs untuk memodifikasi izin peluncuran untuk gambar. | String | Tidak | ||
| LaunchPermission: UserGroups | Grup pengguna untuk memodifikasi izin peluncuran untuk gambar. | String | Tidak | ||
| LaunchPermission: OrganizationArns | AWS Organisasi ARNs untuk memodifikasi izin peluncuran untuk gambar. | String | Tidak | ||
| LaunchPermission: organizationalUnitArns | Unit AWS Organisasi ARNs untuk memodifikasi izin peluncuran untuk gambar. | String | Tidak |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| ModifiedImages | Daftar gambar yang dimodifikasi | Array |
| Modifiedimages:Accountid | ID akun tujuan dari gambar yang didistribusikan. | String |
| ModifiedImages:nama | Nama AMI. | String |
| Modifiedimages:amiid | ID AMI dari gambar yang didistribusikan. | String |
| ModifiedImages:DateStarted | Waktu UTC saat distribusi dimulai. | String |
| ModifiedImages:DateSopped | Waktu UTC ketika distribusi selesai. | String |
| Modifiedimages:Langkah | Langkah di mana distribusi berhenti. | Selesai| ModifyAmiRunning |
| Modifiedimages:Wilayah | AWS Wilayah gambar Tne. | String |
| Modifiedimages:Status | Status distribusi. | Selesai|Gagal | Dibatalkan| TimedOut |
| ModifiedImages: ErrorMessage | Pesan kesalahan, jika ada. | String |
Contoh
Tentukan tindakan langkah dalam dokumen alur kerja.
- name:ModifyImageAttributesaction: ModifyImageAttributes onFailure: Abort inputs: distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages
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 atau kumpulan snapshot yang ada, menentukan berbagai atribut gambar.
Batas Waktu Default: 720 menit
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 |
|---|---|---|---|---|---|
| arsitektur | Arsitektur AMI. | String | Tidak | Nilai yang valid: i386, x86_64, arm64, x86_64_mac, arm64_mac | |
| blockDeviceMapping | Entri pemetaan perangkat blok untuk AMI. | Array | Tidak | ||
| BootMode | Mode boot AMI. | String | Tidak | Nilai yang valid: legacy-bios, uefi, uefi-preferen | |
| deskripsi | Deskripsi untuk AMI. | String | Tidak | ||
| enaSupport | Apakah jaringan yang ditingkatkan dengan ENA diaktifkan. | Boolean | Tidak | ||
| ImageLocation | Lokasi manifes AMI. | String | Tidak | Diperlukan untuk didukung S3 AMIs | |
| IMDSSupport | Tingkat IMDSv2 dukungan. | String | Tidak | Nilai yang valid: v2.0 | |
| includeSnapshotTags | Apakah akan menyertakan tag dari snapshot pertama yang ditentukan dalam pemetaan perangkat blok. | Boolean | Tidak | SALAH |
Ketika disetel ke true, tag disertakan sebagai berikut:
|
| KernelID | ID kernel yang akan digunakan. | String | Tidak | ||
| RamdisKid | ID disk RAM yang akan digunakan. | String | Tidak | ||
| rootDeviceName | Nama perangkat perangkat root. | String | Tidak | Contoh: /dev/sda1 | |
| sriovNetSupport | Jaringan yang disempurnakan dengan antarmuka Intel 82599 VF. | String | Tidak | ||
| TPMSupport | Dukungan versi TPM. | String | Tidak | Nilai yang valid: v2.0 | |
| UEFIData | Data UEFI yang dikodekan Base64. | String | Tidak | ||
| VirtualizationType | 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 yang terdaftar. | String |
Contoh
Tentukan tindakan langkah 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 Systems Manager untuk menjalankannya untuk Anda. sendCommand Untuk informasi selengkapnya, lihat AWS Systems Manager Menjalankan Perintah.
Batas Waktu Default: 12 jam
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 dari instance untuk menjalankan dokumen perintah pada. | Tali | Ya | Ini harus berupa ID instance keluaran dari langkah alur kerja yang meluncurkan instance untuk alur kerja ini. | |
| documentName | Nama dokumen perintah Systems Manager untuk dijalankan. | Tali | Ya | ||
| parameter | Daftar pasangan nilai kunci untuk parameter apa pun yang diperlukan dokumen perintah. | <string>kamus <string, daftar> | Bersyarat | ||
| DocumentVersion | Versi dokumen perintah untuk dijalankan. | String | Tidak | $DEFAULT |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| runCommandId | ID Systems Manager sendCommand yang menjalankan dokumen perintah pada instance. | String |
| status | Status dikembalikan dari Systems ManagersendCommand. | String |
| output | Output dikembalikan dari Systems ManagersendCommand. | Daftar string |
Contoh
Tentukan tindakan langkah 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 Systems Manager untuk menjalankan AWSEC2-RunSysprep dokumen untuk instance Windows sebelum instance build dimatikan untuk snapshot. sendCommand Tindakan ini mengikuti praktik AWS terbaik untuk pengerasan dan pembersihan gambar
Batas Waktu Default: 60 menit
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 dari instance untuk menjalankan AWSEC2-RunSysprep dokumen pada. |
Tali | Ya | Ini harus berupa 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 |
|---|---|---|
| runCommandId | ID Systems Manager sendCommand yang menjalankan AWSEC2-RunSysprep dokumen pada instance. |
String |
| status | Status dikembalikan dari Systems ManagersendCommand. | String |
| output | Output dikembalikan dari Systems ManagersendCommand. | String |
Contoh
Tentukan tindakan langkah 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 instance Linux sebelum instance build dimatikan untuk snapshot. Skrip sanitasi membantu memastikan bahwa gambar akhir mengikuti praktik terbaik keamanan, dan artefak atau pengaturan build yang tidak boleh terbawa ke snapshot Anda dihapus. Untuk informasi lebih lanjut tentang skrip, lihatDiperlukan pembersihan pasca-build. Tindakan langkah ini tidak berlaku untuk gambar kontainer.
Image Builder menggunakan API Systems Manager untuk menjalankan skrip ini. sendCommand Untuk informasi selengkapnya, lihat AWS Systems Manager Menjalankan Perintah.
Batas Waktu Default: 60 menit
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 dari instance untuk membersihkan. | Tali | Ya | Ini harus berupa 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 |
|---|---|---|
| runCommandId | ID Systems Manager sendCommand yang menjalankan skrip sanitasi pada instance. | String |
| status | Status dikembalikan dari Systems ManagersendCommand. | String |
| output | Output dikembalikan dari Systems ManagersendCommand. | String |
Contoh
Tentukan tindakan langkah 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 dengan id instance yang diteruskan sebagai input.
Batas Waktu Default: 30 menit
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 dari instance untuk mengakhiri. | Tali | Ya |
Output: Tidak ada output untuk tindakan langkah ini.
Contoh
Tentukan tindakan langkah dalam dokumen alur kerja.
- name:TerminateInstanceaction: TerminateInstance onFailure: Continue inputs: instanceId.$:i-1234567890abcdef0
WaitForAction
Tindakan langkah ini menjeda alur kerja yang sedang berjalan dan menunggu untuk menerima tindakan eksternal dari tindakan Image Builder API. SendWorkflowStepAction Langkah ini menerbitkan acara ke bus EventBridge EventBridge acara default Anda dengan tipe EC2 Image Builder Workflow Step Waiting detail. Langkah ini juga dapat mengirim pemberitahuan SNS jika Anda memberikan ARN Topik SNS, atau menjalankan fungsi Lambda secara asinkron jika Anda memberikan nama fungsi Lambda.
Batas Waktu Default: 3 hari
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 |
|---|---|---|---|---|---|
| snsTopicArn | Topik SNS opsional ARN untuk mengirim pemberitahuan saat langkah alur kerja tertunda. | String | Tidak | ||
| lambdaFunctionName | Nama opsional atau ARN dari fungsi Lambda untuk memanggil 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 defaultmessage/payload, used for SNS and Lambda respectively. If not provided, generates default message/payload. | String | Tidak | Harus string JSON yang valid, maks 16 KiB |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| tindakan | Tindakan yang dikembalikan oleh tindakan SendWorkflowStepAction API. | String (RESUMEatauSTOP) |
| akal budi | Alasan untuk tindakan yang dikembalikan. | String |
Contoh
Tentukan tindakan langkah dalam dokumen alur kerja dengan pemberitahuan 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 sebuah EC2 contoh untuk dikelola AWS Systems Manager setelah periode yang tidak responsif yang diharapkan. Ini sangat berharga untuk alur kerja dengan interupsi instance 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
Batas Waktu Maks: 180 menit
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 memantau konektivitas SSM. | Tali | Ya | Harus berupa ID EC2 instance yang valid |
Output: Tabel berikut mencakup output untuk tindakan langkah ini.
| Nama output | Deskripsi | Tipe |
|---|---|---|
| Status | Status koneksi Agen SSM. | String |
Contoh
Tentukan tindakan langkah dalam dokumen alur kerja.
- name:WaitForInstanceAfterRebootaction: WaitForSSMAgent onFailure: Abort timeoutInSeconds: 900 # 15 minutes inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
Gunakan output dari nilai tindakan langkah dalam dokumen alur kerja.
$.stepOutputs.WaitForInstanceAfterReboot.Status