Mendefinisikan dan mereferensikan variabel dalam AWSTOE - EC2 Image Builder
ParameterKonstanta

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

Mendefinisikan dan mereferensikan variabel dalam AWSTOE

Variabel menyediakan cara untuk memberi label data dengan nama yang bermakna yang dapat digunakan di seluruh aplikasi. Anda dapat menentukan variabel kustom dengan format sederhana dan mudah dibaca untuk alur kerja yang kompleks, dan mereferensikannya dalam dokumen komponen aplikasi YAMAL untuk komponen. AWSTOE

Bagian ini menyediakan informasi untuk membantu Anda menentukan variabel untuk AWSTOE komponen Anda dalam dokumen komponen aplikasi YAMAL, termasuk sintaks, batasan nama, dan contoh.

Parameter

Parameter adalah variabel yang dapat berubah, dengan pengaturan yang dapat disediakan aplikasi panggilan saat runtime. Anda dapat menentukan parameter di Parameters bagian dokumen YAMB.

Aturan untuk nama parameter

  • Nama harus antara 3 dan 128 karakter panjangnya.

  • Nama hanya dapat berisi karakter alfanumerik (a-z, A-Z, 0-9), tanda hubung (-), atau garis bawah (_).

  • Nama harus unik di dalam dokumen.

  • Nama harus ditentukan sebagai string YAMAL.

Sintaksis

parameters:
  - <name>:
      type: <parameter type>
      default: <parameter value>
      description: <parameter description>

Nama kunci

Diperlukan

Deskripsi

name

Ya

Nama parameter. Harus unik untuk dokumen (tidak boleh sama dengan nama parameter atau konstanta lainnya).

type

Ya

Tipe data parameter. Jenis yang didukung meliputi:string.

default

Tidak

Nilai default untuk parameter.

description

Tidak

Menjelaskan parameter.

Nilai parameter referensi dalam dokumen

Anda dapat mereferensikan parameter dalam input langkah atau loop di dalam dokumen YAMAL Anda, sebagai berikut:

  • Referensi parameter peka huruf besar/kecil, dan namanya harus sama persis.

  • Nama harus dilampirkan dalam kawat gigi keriting ganda. {{ MyParameter}}

  • Spasi diperbolehkan dalam kurung kurawal, dan secara otomatis dipangkas. Misalnya, semua referensi berikut valid:

    {{ MyParameter }}, {{ MyParameter}}, {{MyParameter }}, {{MyParameter}}

  • Referensi dalam dokumen YAMB harus ditentukan sebagai string (terlampir dalam tanda kutip tunggal atau ganda).

    Misalnya: - {{ MyParameter }} tidak valid, karena tidak diidentifikasi sebagai string.

    Namun, referensi berikut ini valid: - '{{ MyParameter }}' dan- "{{ MyParameter }}".

Contoh

Contoh berikut menunjukkan cara menggunakan parameter dalam dokumen YAMB Anda:

  • Lihat parameter dalam input langkah:

    name: Download AWS CLI version 2
schemaVersion: 1.0
parameters:
  - Source:
      type: string
      default: 'https://awscli.amazonaws.com/AWSCLIV2.msi'
      description: The AWS CLI installer source URL.
phases:
  - name: build
    steps:
      - name: Download
        action: WebDownload
        inputs:
          - source: '{{ Source }}'
            destination: 'C:\Windows\Temp\AWSCLIV2.msi'

  • Lihat parameter dalam input loop:

    name: PingHosts
schemaVersion: 1.0
parameters:
  - Hosts:
      type: string
      default: 127.0.0.1,amazon.com
      description: A comma separated list of hosts to ping.
phases:
  - name: build
    steps:
      - name: Ping
        action: ExecuteBash
        loop:
          forEach:
            list: '{{ Hosts }}'
            delimiter: ','
        inputs:
          commands:
            - ping -c 4 {{ loop.value }}

Ganti parameter saat runtime

Anda dapat menggunakan --parameters opsi dari AWS CLI with a key-value pair untuk menetapkan nilai parameter saat runtime.

  • <name><value>Tentukan pasangan kunci-nilai parameter sebagai nama dan nilai, dipisahkan oleh tanda sama dengan (=).

  • Beberapa parameter harus dipisahkan dengan koma.

  • Nama parameter yang tidak ditemukan dalam dokumen komponen YAMB diabaikan.

  • Nama parameter dan nilai keduanya diperlukan.

penting

Parameter komponen adalah nilai teks biasa, dan masukAWS CloudTrail. Kami menyarankan Anda menggunakan AWS Secrets Manager atau AWS Systems Manager Parameter Store untuk menyimpan rahasia Anda. Untuk informasi selengkapnya tentang Secrets Manager, lihat Apa itu Secrets Manager? dalam AWS Secrets ManagerUser Guide. Untuk informasi selengkapnya tentang AWS Systems Manager Parameter Store, lihat AWS Systems ManagerParameter Store di Panduan AWS Systems Manager Pengguna.

Sintaksis

--parameters name1=value1,name2=value2...

Opsi CLI

Diperlukan

Deskripsi

--parameter nama = nilai,...

Tidak

Opsi ini mengambil daftar pasangan kunci-nilai, dengan nama parameter sebagai kunci.
Contoh

Contoh berikut menunjukkan cara menggunakan parameter dalam dokumen YAMB Anda:

  • Pasangan nilai kunci parameter yang ditentukan dalam --parameter opsi ini tidak valid:

    --parameters ntp-server=

  • Tetapkan satu parameter pasangan kunci-nilai dengan --parameter opsi di: AWS CLI

    --parameters ntp-server=ntp-server-windows-qe.us-east1.amazon.com

  • Tetapkan beberapa pasangan nilai kunci parameter dengan --parameter opsi di: AWS CLI

    --parameters ntp-server=ntp-server.amazon.com,http-url=https://internal-us-east1.amazon.com

Konstanta

Konstanta adalah variabel yang tidak dapat diubah yang tidak dapat dimodifikasi atau diganti setelah ditentukan. Konstanta dapat didefinisikan menggunakan nilai-nilai di constants bagian AWSTOE dokumen.

Aturan untuk nama konstan

  • Nama harus antara 3 dan 128 karakter panjangnya.

  • Nama hanya dapat berisi karakter alfanumerik (a-z, A-Z, 0-9), tanda hubung (-), atau garis bawah (_).

  • Nama harus unik di dalam dokumen.

  • Nama harus ditentukan sebagai string YAMAL.

Sintaks

constants:
  - <name>:
      type: <constant type>
      value: <constant value>
Nama kunci Diperlukan Deskripsi

name

Ya

 Nama konstanta. Harus unik untuk dokumen (tidak boleh sama dengan nama parameter atau konstanta lainnya).

value

 Ya Nilai konstanta.

type

 Ya Jenis konstanta. Jenis yang didukung adalahstring.
Referensi nilai konstan dalam dokumen

Anda dapat mereferensikan konstanta dalam input langkah atau loop di dalam dokumen YAMAL Anda, sebagai berikut:

  • Referensi konstan peka huruf besar/kecil, dan namanya harus sama persis.

  • Nama harus dilampirkan dalam kawat gigi keriting ganda. {{ MyConstant}}

  • Spasi diperbolehkan dalam kurung kurawal, dan secara otomatis dipangkas. Misalnya, semua referensi berikut valid:

    {{ MyConstant }}, {{ MyConstant}}, {{MyConstant }}, {{MyConstant}}

  • Referensi dalam dokumen YAMAL harus ditentukan sebagai string (terlampir dalam tanda kutip tunggal atau ganda).

    Misalnya: - {{ MyConstant }} tidak valid, karena tidak diidentifikasi sebagai string.

    Namun, referensi berikut ini valid: - '{{ MyConstant }}' dan- "{{ MyConstant }}".

Contoh

Konstan direferensikan dalam input langkah

name: Download AWS CLI version 2
schemaVersion: 1.0
constants:
  - Source:
      type: string
      value: https://awscli.amazonaws.com/AWSCLIV2.msi
phases:
  - name: build
    steps:
      - name: Download
        action: WebDownload
        inputs:
          - source: '{{ Source }}'
            destination: 'C:\Windows\Temp\AWSCLIV2.msi'

Konstan direferensikan dalam input loop

name: PingHosts
schemaVersion: 1.0
constants:
  - Hosts:
      type: string
      value: 127.0.0.1,amazon.com
phases:
  - name: build
    steps:
      - name: Ping
        action: ExecuteBash
        loop:
          forEach:
            list: '{{ Hosts }}'
            delimiter: ','
        inputs:
          commands:
            - ping -c 4 {{ loop.value }}