翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

カスタムコンポーネントドキュメントでの変数の使用

変数を使用すると、アプリケーション全体で使用できるわかりやすい名前でデータにラベルを付けることができます。複雑なワークフローでは、シンプルで読み取り可能な形式でカスタム変数を定義し、 AWSTOE コンポーネントの YAML アプリケーションコンポーネントドキュメントで参照できます。

このセクションでは、構文、名前の制約、例など、YAML アプリケーション AWSTOE コンポーネントドキュメントでコンポーネントの変数を定義するのに役立つ情報を提供します。

定数

定数は不変の変数で、一度定義すると変更したりオーバーライドしたりすることはできません。定数は、 AWSTOE ドキュメントの constantsセクションの値を使用して定義できます。

[Syntax] (構文)

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

文書内の参照定数値

次のように、YAML ドキュメント内のステップもしくはループ入力で定数を参照できます：

例

ステップ入力で参照される定数

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'

ループ入力で参照される定数

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

パラメータ

パラメータは、呼び出し元のアプリケーションがランタイムに提供できる設定を含む可変変数です。YAML ドキュメントの Parameters セクションでパラメータを定義できます。

構文

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

ドキュメント内の参照パラメータ値

次のように、YAML ドキュメント内のステップ入力またはループ入力でパラメータを参照できます。

例

次の例は YAML ドキュメントでのパラメータの使用方法を示しています。

ランタイムにパラメータをオーバーライドする

の --parametersオプションをキーと値のペア AWS CLI とともに使用して、実行時にパラメータ値を設定できます。

構文

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

例

次の例は YAML ドキュメントでのパラメータの使用方法を示しています。

Systems Manager パラメータストアパラメータを使用する

変数の前に を付けることで、コンポーネントドキュメントで AWS Systems Manager Parameter Store パラメータ (SSM パラメータ) を参照できますaws:ssm。例えば、

{{ aws:ssm:/my/param }} は SSM パラメータ の値に解決されます/my/param。

この機能は、次の SSM パラメータタイプをサポートしています。

パラメータストアの詳細については、 AWS Systems Manager ユーザーガイドのAWS Systems Manager 「パラメータストア」を参照してください。

SSM パラメータ を使用してシー AWS Secrets Manager クレットを参照することもできますSecureString。例: {{ aws:ssm:/aws/reference/secretsmanager/test/test-secret }}。詳細については、「Parameter Store パラメータからのシークレットの参照 AWS Secrets Manager」を参照してください。

必要な IAM 許可

コンポーネントで Systems Manager パラメータを使用するには、インスタンスロールにパラメータリソース ARN のアクセスssm:GetParameter許可が必要です。例えば、次のようになります。

JSON

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

暗号化された値にアクセスするには、次のアクセス許可も必要です。

コンポーネントドキュメントで SSM パラメータを参照する

次の例は、コンポーネント内の Systems Manager パラメータの Systems Manager パラメータストアパラメータを参照する方法を示しています。

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

SSM パラメータの動的ランタイム変数解決

AWSTOE には、変数参照内で実行時に値を操作または変換するために使用できる以下の組み込み関数が用意されています。

関数の解決

resolve 関数は、別の変数参照内の変数参照を解決し、動的変数名参照を可能にします。これは、パラメータパスの一部が可変で、ドキュメントパラメータとして渡される可能性がある SSM パラメータを使用する場合に便利です。

resolve 関数は、SSM パラメータの名前部分の動的解決のみをサポートします。

構文

dynamic_variable 次の例では、 は SSM パラメータの名前を表し、次のいずれかである必要があります。

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

例: 実行時に SSM パラメータを解決する

次の例は、YAML コンポーネントドキュメントで resolve関数を使用する方法を示しています。

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

環境変数を使用します。

AWSTOE は、ビルドインスタンスまたはテストインスタンスに設定されているオペレーティングシステムの環境変数を解決できます。環境変数を参照するには、変数名の前に を付けますenv:。たとえば、 はインスタンスのMY_VAR環境変数の値に{{ env:MY_VAR }}解決されます。

AWSTOE は環境変数名と正確に一致します。名前には、ドット、スペース、括弧など、オペレーティングシステムに有効な任意の文字を含めることができます。たとえば、 {{ env:ProgramFiles(x86) }}は Windows での有効なリファレンスです。

次の例は、コンポーネント内の環境変数を参照する方法を示しています。

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

Image Builder が提供する環境変数

Image Builder がビルドインスタンスまたはテストインスタンスでコンポーネントを実行すると、現在のイメージビルドを記述する環境変数が設定されます。コンポーネントは、 AWSTOE このトピックで前述したenv:変数プレフィックスを使用してこれらの値を読み取ります。

Image Builder には、次の環境変数が用意されています。

次の例は、コンポーネント内の Image Builder 環境変数を読み取る方法を示しています。

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

インスタンスメタデータ (IMDS) 変数を使用する

AWSTOE は、ビルドまたはテストインスタンスの Amazon EC2 インスタンスメタデータサービス (IMDS) から値を解決できます。メタデータ値を参照するには、メタデータパスの前に を付けますaws:imds:。パスはインスタンスメタデータmeta-data/カテゴリを基準としています。たとえば、 はインスタンス ID を{{ aws:imds:instance-id }}解決します。リファレンスは に{{ aws:imds:placement/region }}解決されます AWS リージョン。

インスタンスメタデータの詳細については、「Amazon EC2 ユーザーガイド」の「インスタンスメタデータを使用して EC2 インスタンスを管理する」を参照してください。 Amazon EC2

次の例は、コンポーネントで IMDS 値を参照する方法を示しています。

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

コンテキスト変数を使用する

AWSTOE には、現在の実行とインスタンスを記述するコンテキスト変数が用意されています。コンテキスト変数を参照するには、キーの前に を付けますcontext:。たとえば、 は AWS アカウント ID を{{ context:accountId }}解決します。

AWSTOE には、次のコンテキスト変数が用意されています。

次の例は、コンポーネント内のコンテキスト変数を参照する方法を示しています。

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