スクリプトを使用したブランチ固有のビルド設定の設定サブフォルダに移動するコマンドの設定 Gen 1 アプリケーションのフロントエンドを使用したバックエンドのデプロイ出力フォルダの設定ビルドの一部としてパッケージをインストールするプライベート npm レジストリを使用する OS パッケージのインストールビルドごとにキーバリューストレージを設定するコミットのビルドのスキップすべてのコミットで自動ビルドをオフにする差分ベースのフロントエンドビルドとデプロイの設定 Gen 1 アプリケーションの差分ベースのバックエンドビルドの設定

Amplify コンソールでのビルド仕様の編集

Amplify コンソールでビルド仕様を編集することで、アプリケーションのビルド設定をカスタマイズできます。ビルド設定は、Git リポジトリにamplify.ymlファイルが保存されているブランチを除き、アプリ内のすべてのブランチに適用されます。

Amplify コンソールでビルド設定を編集するには

にサインインする AWS Management Console Amplify コンソールを開きます。
ビルド設定を編集するアプリを選択します。
ナビゲーションペインで、ホスティング を選択し、ビルド設定 を選択します。
「ビルド設定」ページの「アプリビルド仕様」セクションで、「編集」を選択します。
ビルド仕様の編集ウィンドウで、更新を入力します。
[Save] を選択します。

以下のトピックで説明する例を使用して、特定のシナリオのビルド設定を更新できます。

スクリプトを使用したブランチ固有のビルド設定の設定

bash シェルスクリプトを使用してブランチ固有のビルドを設定できます。例えば、次のスクリプトでは、システム環境変数 $AWS_BRANCH を使用して、ブランチ名が main の場合は 1 つのコマンドセットを実行し、ブランチ名が 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

Gen 1 アプリケーションのフロントエンドを使用したバックエンドのデプロイ

注記

このセクションは、Amplify Gen 1 アプリケーションにのみ適用されます。Gen 1 バックエンドは、Amplify Studio と Amplify コマンドラインインターフェイス () を使用して作成されますCLI。

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


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

出力フォルダの設定

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


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

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

npm または yarn コマンドを使って、ビルド中にパッケージをインストールすることができます。


frontend:
  phases:
    build:
      commands:
        - npm install -g <package>
        - <package> 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 パッケージのインストール

Amplify の AL2023 イメージは、という名前の非特権ユーザーでコードを実行しますamplify。Amplify は、Linux コマンドを使用して OS sudo コマンドを実行する権限をこのユーザーに付与します。依存関係が欠落している OS パッケージをインストールする場合は、 yumやなどのコマンドを rpmで使用できますsudo。

次のビルドセクションの例は、 sudo コマンドを使用して OS パッケージをインストールするための構文を示しています。


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

ビルドごとにキーバリューストレージを設定する

envCache はビルド時に key-value ストレージを提供します。envCache に保存された値はビルド中にのみ変更でき、次回のビルドで再利用できます。envCache を使用することで、デプロイされた環境に情報を保存し、それを連続したビルドでビルドコンテナを利用できるようにします。envCache に保存された値とは異なり、ビルド中に環境変数を変更しても、将来のビルドには反映されません。

使用例:


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

コミットのビルドのスキップ

特定のコミットの自動ビルドをスキップするには、コミットメッセージの末尾に [skip-cd] というテキストを含めます。

すべてのコミットで自動ビルドをオフにする

Amplify を設定して、コードコミットごとに自動ビルドをオフにできます。セットアップするには、アプリ設定 、ブランチ設定 を選択し、接続されたブランチを一覧表示するブランチセクションを見つけます。ブランチを選択し、アクション 、自動ビルドを無効にする を選択します。そのブランチへの新しいコミットは、新しいビルドを開始しません。

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

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

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

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

オプションで、デフォルトパスをリポジトリのルートからの相対パス (distなど) でオーバーライドするように環境変数 AMPLIFY_DIFF_DEPLOY_ROOT を設定できます。

Gen 1 アプリケーションの差分ベースのバックエンドビルドの設定

注記

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

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

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

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

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

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

ドキュメントの表記規則

ビルド仕様について

monorepo ビルド設定の構成