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

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

変数を使用すると、アプリケーション全体で使用できるわかりやすい名前でデータにラベルを付けることができます。複雑なワークフローでは、シンプルで読み取り可能な形式でカスタム変数を定義し、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) }}"