ビルド仕様のオペレーティングシステムブランチ固有のビルド設定サブフォルダへの移動フロントエンドでのバックエンドのデプロイ出力フォルダの設定ビルドの一部としてパッケージをインストールするプライベート npm レジストリを使用する OS パッケージのインストールビルドごとのキーと値のストレージビルドをスキップする値は、ビルドをスキップする自動ビルドを無効にする差分ベースのフロントエンドビルドとデプロイを有効または無効にする差分ベースのバックエンドビルドを有効または無効にする

ビルド設定の構成

Amplify Hosting でアプリをデプロイすると、package.jsonリポジトリ内のファイルを検査することで、フロントエンドフレームワークと関連するビルド設定が自動的に検出されます。アプリのビルド設定を保存するには、次のオプションがあります。

ビルド設定を Amplify コンソールに保存-Amplify コンソールはビルド設定を自動検出して保存し、Amplify コンソールからアクセスできるようにします。Amplifyは、amplify.ymlリポジトリにファイルが保存されていない限り、これらの設定をすべてのブランチに適用します。
ビルド設定をリポジトリに保存-amplify.yml ファイルをダウンロードしてリポジトリのルートに追加します。

Amplify コンソールでアプリのビルド設定を編集するには、[アプリ設定]、[ビルド設定] を選択します。ビルド設定は、amplify.ymlリポジトリにファイルが保存されているブランチを除いて、アプリ内のすべてのブランチに適用されます。

注記

ビルド設定は、アプリが継続的デプロイ用に設定され、gitリポジトリに接続されている場合にのみ、Amplifyコンソールのアプリ設定メニューに表示されます。このタイプのデプロイの手順については、「既存のコードを使い始める」を参照してください。

ビルド仕様のオペレーティングシステム

ビルド環境には、Amplifyがビルドを実行するために使用するオペレーティングシステム、プログラミング言語ランタイム、およびツールの組み合わせを表します。YAML は次のように構成されます。


version: 1
env:
  variables:
    key: value
backend:
  phases:
    preBuild:
      commands:
        - *enter command*
    build:
      commands:
        - *enter command*
    postBuild:
        commands:
        - *enter command*
frontend:
  phases:
    preBuild:
      commands:
        - cd react-app
        - npm ci
    build:
      commands:
        - npm run build
  artifacts:
    files:
        - location
        - location
    discard-paths: yes
    baseDirectory: location
  cache:
    paths:
        - path
        - path
test:
  phases:
    preTest:
      commands:
        - *enter command*
    test:
      commands:
        - *enter command*
    postTest:
      commands:
        - *enter command*
  artifacts:
    files:
        - location
        - location
    configFilePath: *location*
    baseDirectory: *location*

バージョン-Amplify YAML のバージョン番号を表します。
APproot-このアプリケーションが存在するリポジトリ内のパス。複数のアプリケーションが定義されていない限り無視されます。
env - 環境変数をこのセクションに追加します。また、環境変数はコンソールを使用して追加することもできます。
backend - Amplify CLI コマンドを実行して、バックエンドのプロビジョン、Lambda 関数の更新、または継続的なデプロイの一環としての GraphQL スキーマの更新を行います。フロントエンドでバックエンドをデプロイする方法について説明します。
frontend - フロントエンドのビルドコマンドを実行します。
test-テストフェーズ中にコマンドを実行します。アプリにテストを追加する方法をご覧ください。
フロントエンド、バックエンド、テストには、ビルドの各シーケンスで実行されるコマンドを表す 3 つのフェーズがあります。
preBuild - preBuild スクリプトは、実際のビルドの開始前、依存関係のインストール後に実行されます。

build - お客様のビルドコマンド。

postBuild - ビルド後のスクリプトはビルド完了後に実行されるため、必要なすべてのアーティファクトを出力ディレクトリにコピーしました。
artifacts>base-directory - ビルドアーティファクトが存在するディレクトリ。
artifacts>files - デプロイするアーティファクトからファイルを指定します。**/* は、すべてのファイルを含めることを意味します。
cache-buildspec の cache フィールドは、node_modules フォルダーなどのビルド時の依存関係をキャッシュするために使用され、お客様のアプリが組み込まれているパッケージマネージャーとフレームワークに基づいて自動的に提案されます。最初のビルドでは、ここにあるパスはすべてキャッシュされ、それ以降のビルドではキャッシュを再膨張させ、キャッシュされた依存関係を可能な限り使用してビルド時間を短縮します。

ブランチ固有のビルド設定

bash シェルスクリプトを使用してブランチ固有のビルドを設定できます。たとえば、次のスクリプトは、システム環境変数 $AWS_BRANCH を使用して、ブランチ名が main の場合はあるコマンドセットを実行し、ブランチ名が dev の場合は別のコマンドセットを実行します。


frontend:
  phases:
    build:
      commands:
        - if [ "${AWS_BRANCH}" = "main" ]; then echo "main branch"; fi
        - if [ "${AWS_BRANCH}" = "dev" ]; then echo "dev branch"; fi

サブフォルダへの移動

モノリポジトリの場合、cdユーザーはビルドを実行するためのフォルダーにアクセスできるようにしたいと考えています。cdコマンドを実行すると、ビルドのすべての段階に適用されるため、コマンドを別々のフェーズで繰り返す必要はありません。


version: 1
env:
  variables:
    key: value
frontend:
  phases:
    preBuild:
      commands:
        - cd react-app
        - npm ci
    build:
      commands:
        - npm run build

フロントエンドでのバックエンドのデプロイ

amplifyPushこのコマンドは、バックエンドのデプロイに役立つヘルパースクリプトです。以下のビルド設定によって、現在のブランチにデプロイする上で適切なバックエンド環境が自動的に判別されます。


version: 1
env:
  variables:
    key: value
backend:
  phases:
    build:
      commands:
        - amplifyPush --simple

出力フォルダの設定

次のビルド設定は、出力ディレクトリをパブリックフォルダに設定します。


frontend:
  phases:
    commands:
      build:
        - yarn run build
  artifacts:
    baseDirectory: public

ビルドの一部としてパッケージをインストールする

npmyarnまたはコマンドを使用して、ビルド中にパッケージをインストールできます。


frontend:
  phases:
    build:
      commands:
        - npm install -g pkg-foo
        - pkg-foo deploy
        - yarn run build
  artifacts:
    baseDirectory: public

プライベート npm レジストリを使用する

プライベートレジストリへのリファレンスは、ビルド設定で追加するか、環境変数として追加することができます。


build:
  phases:
    preBuild:
      commands:
        - npm config set <key> <value>
        - npm config set registry https://registry.npmjs.org
        - npm config set always-auth true
        - npm config set email hello@amplifyapp.com
        - yarn install

OS パッケージのインストール

OS パッケージをインストールして、不足している依存関係を入手します。


build:
  phases:
    preBuild:
      commands:
        - yum install -y <package>

ビルドごとのキーと値のストレージ

envCacheはビルド時にキーバリューストレージを提供します。に保存されている値はenvCache、ビルド中にのみ変更でき、次のビルドで再利用できます。を使用するとenvCache、デプロイされた環境に関する情報を保存し、それを次のビルドでビルドコンテナで使用できるようにすることができます。に保存されている値とは異なりenvCache、ビルド中に環境変数に加えられた変更は、future ビルドに永続化されません。

使用例:


envCache --set <key> <value>
envCache --get <key>

ビルドをスキップする値は、ビルドをスキップする

特定のコミットの自動ビルドをスキップするには、コミットメッセージの最後に [skip-cd] というテキストを含めてください。現在、[skip-cd] は GitHub Git リポジトリでのみサポートされています。

自動ビルドを無効にする

コードコミットのたびに自動ビルドを無効にするように Amplify を設定できます。セットアップするには、[アプリ設定]、[一般] を選択し、接続されているブランチを一覧表示する [ブランチ] セクションまでスクロールします。ブランチを選択し、[アクション]、[auto ビルドを無効にする] を選択します。さらにそのブランチにコミットしても、新しいビルドは作成されません。

差分ベースのフロントエンドビルドとデプロイを有効または無効にする

差分ベースのフロントエンドビルドを使用するように Amplify を設定できます。有効にすると、各ビルドの開始時に、appRoot/src/ Amplifyはデフォルトで自分またはフォルダーのいずれかに対して差分を実行しようとします。Amplify で違いが見つからない場合、フロントエンドのビルド、テスト (設定されている場合)、デプロイの手順はスキップされ、ホストされているアプリは更新されません。

差分ベースのフロントエンドビルドとデプロイを設定するには

にサインインして Amplify コンソールを開きます。AWS Management Console
差分ベースのフロントエンドビルドとデプロイを設定するアプリを選択します。
ナビゲーションペインで、[アプリ設定]、[環境変数] を選択します。
[環境変数] セクションで、[変数の管理] を選択します。
環境変数を設定する手順は、差分ベースのフロントエンドビルドとデプロイを有効にするか無効にするかによって異なります。
- 差分ベースのフロントエンドのビルドとデプロイを有効にするには
  1. [変数の管理] セクションの [変数] に、次のように入力しますAMPLIFY_DIFF_DEPLOY。
  2. [Value (値)] に「true」と入力します。
- 差分ベースのフロントエンドビルドとデプロイを無効にするには
  1. 以下のいずれかを実行します。
    - 「変数の管理」セクションで、AMPLIFY_DIFF_DEPLOYを探します。[Value (値)] に「false」と入力します。
    - AMPLIFY_DIFF_DEPLOY環境変数を削除します。

オプションで、AMPLIFY_DIFF_DEPLOY_ROOT環境変数を設定して、デフォルトパスをリポジトリのルートを基準としたパス (など) でオーバーライドすることもできますdist。

差分ベースのバックエンドビルドを有効または無効にする

AMPLIFY_DIFF_BACKEND環境変数を使用して、差分ベースのバックエンドビルドを使用するように Amplify Hosting を設定できます。差分ベースのバックエンドビルドを有効にすると、各ビルドの開始時に Amplifyamplify はリポジトリ内のフォルダーで diff を実行しようとします。Amplifyで違いが見つからない場合、バックエンドのビルドステップはスキップされ、バックエンドリソースは更新されません。amplifyプロジェクトのリポジトリにフォルダーがない場合、AmplifyAMPLIFY_DIFF_BACKEND は環境変数の値を無視します。

現在、バックエンドフェーズのビルド設定でカスタムコマンドが指定されている場合、条件付きバックエンドビルドは機能しません。これらのカスタムコマンドを実行するには、amplify.ymlアプリのファイルにあるビルド設定のフロントエンドフェーズに移動する必要があります。

差分ベースのバックエンドビルドを設定するには

にサインインして Amplify コンソールを開きます。AWS Management Console
差分ベースのバックエンドビルドを設定するアプリを選択します。
ナビゲーションペインで、[アプリ設定]、[環境変数] を選択します。
[環境変数] セクションで、[変数の管理] を選択します。
環境変数を設定する手順は、差分ベースのバックエンドビルドを有効にするか無効にするかによって異なります。
- 差分ベースのバックエンドビルドを有効にするには
  1. [変数の管理] セクションの [変数] に、次のように入力しますAMPLIFY_DIFF_BACKEND。
  2. [Value (値)] に「true」と入力します。
- 差分ベースのバックエンドビルドを無効にするには
  1. 以下のいずれかを実行します。
    - 「変数の管理」セクションで、AMPLIFY_DIFF_BACKENDを探します。[Value (値)] に「false」と入力します。
    - AMPLIFY_DIFF_BACKEND環境変数を削除します。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

カスタムドメインに関するトラブルシューティング

モノレポビルド設定