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

パラメータ命名規則

• 名前は 3 文字以上 128 文字以下でなければならない。

• 名前には、英数字（a-z, A-Z, 0-9）、ダッシュ（-）、アンダースコア（_）のみを含めることができます。

• 名前は文書内で一意でなければならない。

• 名前は YAML 文字列として指定する必要があります。

• パラメータ参照は大文字と小文字が区別され、名前は完全に一致する必要があります。

• 名前は二重中括弧 で囲む必要があります{{MyParameter}}。

• 中括弧内にはスペースを入れてもかまいませんが、自動的に切り捨てられます。例えば、以下のリファレンスはすべて有効です。

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

• YAML ドキュメント内の参照は文字列 (一重引用符または二重引用符で囲む) として指定する必要があります。

  例えば、- {{ MyParameter }} は文字列として識別されないため無効です。

  ただし、参照先 - '{{ MyParameter }}' と - "{{ MyParameter }}" はどちらも有効です。

• ステップ入力のパラメータを参照してください。

  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'

• ループ入力のパラメータを参照する：

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

• <name><value>パラメータのキーと値のペアを等号 (=) で区切って名前と値として指定します。

• 複数のパラメータはカンマで区切る必要があります。

• YAML コンポーネントドキュメントにないパラメータ名は無視されます。

• パラメータ名と値はどちらも必須です。

• この --parameter オプションで指定されたパラメータのキーと値のペアは無効です。

  --parameters ntp-server=

• AWS CLIに --parameter オプションでパラメータのキーと値のペアを 1 つ設定します。

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

• AWS CLIの --parameter オプションで複数のパラメータのキーと値のペアを設定します。

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

定数命名規則

• 名前は 3 文字以上 128 文字以下でなければならない。

• 名前には、英数字（a-z, A-Z, 0-9）、ダッシュ（-）、アンダースコア（_）のみを含めることができます。

• 名前は文書内で一意でなければならない。

• 名前は YAML 文字列として指定する必要があります。

• 定数参照は大文字と小文字を区別し、名前は正確に一致しなければならない。

• 名前は二重中括{{MyConstant弧 で囲む必要があります}}。

• 中括弧内にはスペースを入れてもかまいませんが、自動的に切り捨てられます。例えば、以下のリファレンスはすべて有効です。

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

• YAML ドキュメント内の参照は文字列 (一重引用符または二重引用符で囲む) として指定する必要があります。

  例えば、- {{ MyConstant }} は文字列として識別されないため無効です。

  ただし、参照先 - '{{ MyConstant }}' と - "{{ MyConstant }}" はどちらも有効です。