翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
App Runner 設定ファイルのリファレンス
注記
設定ファイルは、ソースコードに基づくサービスにのみ適用されます。イメージベースのサービスでは設定ファイルは使用できません。
このトピックは、 AWS App Runner 設定ファイルの構文とセマンティクスに関する包括的なリファレンスガイドです。App Runner 設定ファイルの概要については、「」を参照してください設定ファイルを使用した App Runner サービスオプションの設定。
App Runner 設定ファイルは YAML ファイルです。に名前を付けapprunner.yaml
、アプリケーションのリポジトリのソースディレクトリに配置します。
構造の概要
App Runner 設定ファイルは YAML ファイルです。に名前を付けapprunner.yaml
、アプリケーションのリポジトリのソースディレクトリに配置します。
App Runner 設定ファイルには、次の主要な部分が含まれています。
-
上位セクション – 最上位キーが含まれます
-
ビルドセクション – ビルドステージを設定します
-
実行セクション – ランタイムステージを設定します
上位セクション
ファイルの上部にあるキーは、ファイルとサービスランタイムに関する一般的な情報を提供します。次のキーを使用できます。
-
version
– 必須。App Runner 設定ファイルのバージョン。理想的には、最新バージョンを使用してください。[Syntax] (構文)
version:
version
例
version: 1.0
-
runtime
– 必須。アプリケーションが使用するランタイムの名前。App Runner が提供するさまざまなプログラミングプラットフォームで使用可能なランタイムについては、「」を参照してくださいソースコードに基づく App Runner サービス。注記
マネージドランタイムの命名規則は
<language-name><major-version>
です。[Syntax] (構文)
runtime:
runtime-name
例
runtime: python3
ビルドセクション
ビルドセクションでは、App Runner サービスデプロイのビルドステージを設定します。ビルドコマンドと環境変数を指定できます。ビルドコマンドが必要です。
セクションは build:
キーで始まり、次のサブキーがあります。
-
commands
– 必須。さまざまなビルドフェーズで App Runner が実行するコマンドを指定します。次のサブキーが含まれます。-
pre-build
– オプション。ビルドの前に App Runner が実行するコマンド。例えば、npm依存関係をインストールしたり、ライブラリをテストしたりします。 -
build
– 必須。App Runner がアプリケーションを構築するために実行するコマンド。例えば、 を使用しますpipenv。 -
post-build
– オプション。App Runner がビルド後に実行するコマンド。例えば、Maven を使用してビルドアーティファクトを JAR または WAR ファイルにパッケージ化するか、テストを実行します。
[Syntax] (構文)
build: commands: pre-build: -
command
-…
build: -command
-…
post-build: -command
-…
例
build: commands: pre-build: - yum install openssl build: - pip install -r requirements.txt post-build: - python manage.py test
-
-
env
– オプション。ビルドステージのカスタム環境変数を指定します。名前と値のスカラーマッピングとして定義されます。これらの変数は、ビルドコマンドで名前で参照できます。注記
この設定ファイルには、2 つの異なる場所に 2 つの異なる
env
エントリがあります。1 つのセットはビルドセクションにあり、もう 1 つのセットは実行セクションにあります。-
ビルドセクションの
env
セットは、ビルドプロセス中にpre-build
、build
、post-build
、およびpre-run
コマンドで参照できます。重要 -
pre-run
コマンドは、ビルドセクションで定義されている環境変数にのみアクセスできますが、このファイルの Run セクションにあることに注意してください。 -
Run セクションの
env
セットは、ランタイム環境のrun
コマンドで参照できます。
[Syntax] (構文)
build: env: - name:
name1
value:value1
- name:name2
value:value2
-…
例
build: env: - name: DJANGO_SETTINGS_MODULE value: "django_apprunner.settings" - name: MY_VAR_EXAMPLE value: "example"
-
実行セクション
実行セクションでは、App Runner アプリケーションデプロイのコンテナ実行ステージを設定します。ランタイムバージョン、実行前コマンド (変更された形式のみ)、スタートコマンド、ネットワークポート、環境変数を指定できます。
セクションは run:
キーで始まり、次のサブキーがあります。
-
runtime-version
– オプション。App Runner サービス用にロックするランタイムバージョンを指定します。デフォルトでは、メジャーバージョンのみがロックされます。App Runner は、デプロイまたはサービスの更新のたびにランタイムで使用できる最新のマイナーバージョンとパッチバージョンを使用します。メジャーバージョンとマイナーバージョンを指定すると、どちらもロックされ、App Runner はパッチバージョンのみを更新します。メジャーバージョン、マイナーバージョン、パッチバージョンを指定すると、サービスは特定のランタイムバージョンでロックされ、App Runner によって更新されることはありません。
[Syntax] (構文)
run: runtime-version:
major[.minor[.patch]]
注記
一部のプラットフォームのランタイムには、異なるバージョンコンポーネントがあります。詳細については、特定のプラットフォームのトピックを参照してください。
例
runtime: python3 run: runtime-version: 3.7
-
pre-run
– オプション。 ビルド使用法の改訂のみ。ビルドイメージから実行イメージにアプリケーションをコピーした後に App Runner が実行するコマンドを指定します。/app
ディレクトリ外の実行イメージを変更するコマンドをここに入力できます。例えば、/app
ディレクトリの外部にある追加のグローバル依存関係をインストールする必要がある場合は、このサブセクションに必要なコマンドを入力してインストールします。App Runner ビルドプロセスの詳細については、「」を参照してくださいマネージドランタイムバージョンと App Runner ビルド。注記
-
重要 —
pre-run
コマンドは実行セクションにリストされていますが、この設定ファイルのビルドセクションで定義されている環境変数のみを参照できます。この実行セクションで定義されている環境変数を参照することはできません。 -
pre-run
パラメータは、改訂された App Runner ビルドでのみサポートされます。アプリケーションが元の App Runner ビルドでサポートされているランタイムバージョンを使用している場合は、このパラメータを設定ファイルに挿入しないでください。詳細については、「マネージドランタイムバージョンと App Runner ビルド」を参照してください。
[Syntax] (構文)
run: pre-run: -
command
-…
-
-
command
– 必須。App Runner がアプリケーションビルドの完了後にアプリケーションを実行するために使用するコマンド。[Syntax] (構文)
run: command:
command
-
network
– オプション。アプリケーションがリッスンするポートを指定します。この情報には以下が含まれます。-
port
– オプション。指定した場合、これはアプリケーションがリッスンするポート番号です。デフォルト:8080
。 -
env
– オプション。指定した場合、App Runner はデフォルトの環境変数 で同じポート番号を渡すことに加えて (代わりに)、この環境変数のコンテナにポート番号を渡しますPORT
。つまり、 を指定するとenv
、App Runner は 2 つの環境変数でポート番号を渡します。
[Syntax] (構文)
run: network: port:
port-number
env:env-variable-name
例
run: network: port: 8000 env: MY_APP_PORT
-
-
env
– オプション。実行ステージのカスタム環境変数の定義。名前と値のスカラーマッピングとして定義されます。ランタイム環境では、これらの変数を名前で参照できます。注記
この設定ファイルには、2 つの異なる場所に 2 つの異なる
env
エントリがあります。1 つのセットはビルドセクションにあり、もう 1 つのセットは実行セクションにあります。-
ビルドセクションの
env
セットは、ビルドプロセス中にpre-build
、build
、post-build
、およびpre-run
コマンドで参照できます。重要 -
pre-run
コマンドは、ビルドセクションで定義されている環境変数にのみアクセスできますが、このファイルの Run セクションにあることに注意してください。 -
Run セクションの
env
セットは、ランタイム環境のrun
コマンドで参照できます。
[Syntax] (構文)
run: env: - name:
name1
value:value1
- name:name2
value:value2
secrets: - name:name1
value-from:arn:aws:secretsmanager:region:aws_account_id:secret:secret-id
- name:name2
value-from:arn:aws:ssm:region:aws_account_id:parameter/parameter-name
-…
例
run: env: - name: MY_VAR_EXAMPLE value: "example" secrets: - name: my-secret value-from: "arn:aws:secretsmanager:us-east-1:123456789012:secret:testingstackAppRunnerConstr-kJFXde2ULKbT-S7t8xR:username::" - name: my-parameter value-from: "arn:aws:ssm:us-east-1:123456789012:parameter/parameter-name" - name: my-parameter-only-name value-from: "parameter-name"
-