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

Gunakan variabel dalam dokumen komponen kustom Anda

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 YAMM untuk sebuah 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.

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.

Sintaksis

constants:
  - <name>:
      type: <constant type>
      value: <constant value>

Referensi nilai konstan dalam dokumen

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

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 }}

Parameter

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

Sintaksis

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

Nilai parameter referensi dalam dokumen

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

Contoh

Contoh berikut menunjukkan cara menggunakan parameter dalam dokumen YAMM Anda:

Ganti parameter saat runtime

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

Sintaksis

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

Contoh

Contoh berikut menunjukkan cara menggunakan parameter dalam dokumen YAMM Anda:

Gunakan parameter Systems Manager Parameter Store

Anda dapat mereferensikan AWS Systems Manager parameter Parameter Store (parameter SSM) dalam dokumen komponen Anda dengan mengawali variabel dengan. aws:ssm Misalnya,

{{ aws:ssm:/my/param }}menyelesaikan ke nilai parameter SSM. /my/param

Fitur ini mendukung jenis parameter SSM berikut:

Untuk informasi selengkapnya tentang Parameter Store lihat AWS Systems Manager Parameter Menyimpan di Panduan AWS Systems Manager Pengguna.

Anda juga dapat mereferensikan AWS Secrets Manager rahasia menggunakan parameter SecureString SSM. Sebagai contoh: {{ aws:ssm:/aws/reference/secretsmanager/test/test-secret }}. Untuk informasi selengkapnya, lihat Mereferensikan AWS Secrets Manager rahasia dari parameter Parameter Store.

Izin IAM yang diperlukan

Untuk menggunakan parameter Systems Manager di komponen Anda, peran instans Anda harus memiliki ssm:GetParameter izin untuk ARN sumber daya parameter. Contoh:

JSON

{
	"Version":"2012-10-17",
	"Statement": [
		{
			"Effect": "Allow",
			"Action": "ssm:GetParameter",
			"Resource": "arn:aws:ssm:*:111122223333:parameter/ImageBuilder-*"
		}
	]
}

Untuk mengakses nilai terenkripsi, Anda juga memerlukan izin berikut:

Referensi parameter SSM dalam dokumen komponen

Contoh berikut menunjukkan cara mereferensikan parameter Systems Manager Parameter Store parameter Systems Manager dalam komponen:

name: UseSSMParameterVariable
description: This is a sample component document that prints out the value of an SSM Parameter. Never do this for a SecureString parameter.
schemaVersion: 1.0

phases:
  - name: verify
    steps:
      - name: EchoParameterValue
        action: ExecuteBash
        inputs:
          commands:
            - echo "Log SSM parameter name: /my/test/param, value {{ aws:ssm:/my/test/param }}."

Resolusi variabel runtime dinamis untuk parameter SSM

AWSTOE menyediakan fungsi bawaan berikut yang dapat Anda gunakan dalam referensi variabel untuk memanipulasi atau mengubah nilai saat runtime.

menyelesaikan fungsi

resolveFungsi ini menyelesaikan referensi variabel di dalam referensi variabel lain, memungkinkan untuk referensi nama variabel dinamis. Ini berguna saat bekerja dengan parameter SSM di mana bagian dari jalur parameter dapat bervariasi dan diteruskan sebagai parameter dokumen.

resolveFungsi ini hanya mendukung resolusi dinamis dari bagian nama parameter SSM.

Sintaksis

dynamic_variableDalam contoh berikut mewakili nama parameter SSM, dan harus menjadi salah satu dari berikut ini:

{{ aws:ssm:resolve(dynamic_variable) }}

Contoh: Menyelesaikan parameter SSM saat runtime

Contoh berikut menunjukkan cara menggunakan resolve fungsi dalam dokumen komponen YAMM:

name: SsmParameterTest
description: This component verifies an SSM parameter variable reference with the echo command.
schemaVersion: 1.0

parameters:
  - parameter-name:
      type: string
      description: "test"

phases:
  - name: validate
    steps:
      - name: PrintDynamicVariable
        action: ExecuteBash
        inputs:
          commands:
            - echo "{{ aws:ssm:resolve(parameter-name) }}"

Menggunakan variabel lingkungan

AWSTOE dapat menyelesaikan variabel lingkungan sistem operasi yang disetel pada instance build atau pengujian. Untuk mereferensikan variabel lingkungan, awali nama variabel denganenv:. Misalnya, {{ env:MY_VAR }} menyelesaikan nilai variabel MY_VAR lingkungan pada instance.

AWSTOE sama persis dengan nama variabel lingkungan. Sebuah nama dapat berisi karakter apa pun yang valid untuk sistem operasi, termasuk titik, spasi, dan tanda kurung. Misalnya, {{ env:ProgramFiles(x86) }} adalah referensi yang valid pada Windows.

Contoh berikut menunjukkan bagaimana untuk referensi variabel lingkungan dalam komponen:

name: UseEnvironmentVariable
description: This sample component prints out the value of an environment variable.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoEnvironmentVariable
        action: ExecuteBash
        inputs:
          commands:
            - echo "The value of SOME_VAR is {{ env:SOME_VAR }}."

Variabel lingkungan yang disediakan Image Builder

Saat Image Builder menjalankan komponen pada instance build atau pengujian, Image Builder menetapkan variabel lingkungan yang menggambarkan build image saat ini. Komponen Anda membaca nilai-nilai ini dengan awalan AWSTOE env: variabel yang dijelaskan sebelumnya dalam topik ini.

Image Builder menyediakan variabel lingkungan berikut.

Contoh berikut menunjukkan cara membaca variabel lingkungan Image Builder dalam komponen:

name: UseImageBuilderEnvironmentVariables
description: This sample component prints out Image Builder environment variable values.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoImageBuildValues
        action: ExecuteBash
        inputs:
          commands:
            - echo "Image phase: {{ env:IMAGE_PHASE }}."
            - echo "Image build version ARN: {{ env:IMAGE_BUILD_VERSION_ARN }}."

Gunakan variabel metadata instance (IMDS)

AWSTOE dapat menyelesaikan nilai dari Amazon EC2 Instance Metadata Service (IMDS) pada instance build atau pengujian. Untuk mereferensikan nilai metadata, awali jalur metadata dengan. aws:imds: Path relatif terhadap kategori metadata meta-data/ instance. Misalnya, {{ aws:imds:instance-id }} menyelesaikan ID instance. Referensi {{ aws:imds:placement/region }} menyelesaikan ke. Wilayah AWS

Untuk informasi selengkapnya tentang metadata instans, lihat Menggunakan metadata instans untuk mengelola instans EC2 Anda di Panduan Pengguna Amazon EC2.

Contoh berikut menunjukkan bagaimana untuk referensi nilai IMDS dalam komponen:

name: UseInstanceMetadataVariable
description: This sample component prints out the instance ID from IMDS.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoInstanceId
        action: ExecuteBash
        inputs:
          commands:
            - echo "The instance ID is {{ aws:imds:instance-id }}."

Gunakan variabel konteks

AWSTOE menyediakan variabel konteks yang menggambarkan eksekusi dan instance saat ini. Untuk mereferensikan variabel konteks, awali kunci dengancontext:. Misalnya, {{ context:accountId }} menyelesaikan ke ID AWS akun.

AWSTOE menyediakan variabel konteks berikut.

Contoh berikut menunjukkan bagaimana untuk referensi variabel konteks dalam komponen:

name: UseContextVariables
description: This sample component prints out context variable values.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoContextValues
        action: ExecuteBash
        inputs:
          commands:
            - echo "Account: {{ context:accountId }}, OS: {{ context:osName }}."