イメージレシピの新しいバージョンを作成する

新しいイメージレシピバージョンを作成するには：

1. レシピの詳細ページの上部で、新しいバージョンを作成 を選択します。これにより、イメージレシピの作成ページが開きます。

2. 新しいバージョンを作成するには、変更を加え、レシピの作成を選択します。

   最終イメージには、 AWS Marketplace イメージ製品とコンポーネントから最大 9 つの製品コードを含めることができます。ベースイメージとコンポーネントがこの制限を超えた場合、Image Builder はレシピの作成中にエラーを返します。

1. CLI 入力 JSON ファイルの作成

   create-image-recipe コマンドのすべての入力をインラインコマンドパラメータで指定できます。ただし、生成されるコマンドはかなり長くなる可能性があります。コマンドを効率化するために、代わりにすべてのレシピ設定を含む JSON ファイルを提供できます。

   注記

   JSON ファイル内のデータ値の命名規則は、Image Builder API オペレーションリクエストパラメータに指定されたパターンに従います。API オペレーションリクエストパラメータを確認するには、EC2 Image Builder API リファレンスの CreateImageRecipe コマンドを参照してください。

   データ値をコマンドラインパラメータとして指定するには、AWS CLI コマンドリファレンスで指定されているパラメータ名を参照してください。

   以下に、これらの例で指定するパラメータの概要を示します。

   • 名前 (文字列、必須) — イメージレシピの名前。

   • 説明 (文字列) — イメージレシピの説明。

   • parentImage (文字列、必須) — イメージレシピがカスタマイズしたイメージのベースとして使用するイメージ。親イメージは、次のいずれかのオプションを使用して指定できます。

     • AMI ID – カスタマイズする特定の AMI ( などami-1234567890abcdef1) がある場合に使用します。AMI ID は静的であるため、レシピで新しいベースイメージを自動的に取得する場合は、Image Builder イメージ ARN または SSM パラメータを使用することをお勧めします。

     • Image Builder イメージリソース ARN – Image Builder イメージ上にビルドする場合に使用します。これには、Image Builder が最も一般的なオペレーティングシステムに提供する Amazon マネージドイメージと、以前に作成したイメージが含まれます。セマンティックバージョンでイメージ ARN を指定するか、バージョンワイルドカードを使用して常に最新バージョンを取得します。

     • AWS Systems Manager (SSM) Parameter Store パラメータ – 新しいレシピバージョンを作成せずにレシピで新しい AMI IDs を自動的に取得する場合に使用します。パラメータの前に を付けssm:、その後にパラメータ名または ARN を付けます。これは、常に最新の Amazon Linux または Windows ベースイメージを使用する必要があるパイプラインに最適です。

     • AWS Marketplace product ID – で AMI 製品をサブスクライブ AWS Marketplace し、さらにカスタマイズする場合に使用します。

     注記

     • AMI ID または AMI に解決される SSM パラメータを使用する場合は、アカウントでその AMI にアクセスできる必要があります。AMI は、Image Builder がビルドを実行するのと同じリージョンにも存在する必要があります。

     • Linux および macOS の例では AMI ID を指定し、Windows の例では Image Builder イメージ ARN を使用します。

   • semanticVersion (文字列、必須) – 作成するバージョン番号を <major>.<minor>.<patch> の形式で入力します。Image Builder はレシピの自動バージョン増分をサポートしているため、レシピバージョンでワイルドカードパターンを使用できます。などのワイルドカードバージョンでレシピを作成すると1.0.x、Image Builder は自動的にバージョンを増分します (、1.0.11.0.2、 など1.0.3)。これにより、レシピのバージョンを手動で追跡して増分する必要がなくなります。Image Builder リソースのセマンティックバージョニングの詳細については、Image Builder でのセマンティックバージョニングを参照してください。

   • components (配列、オプション) – ComponentConfiguration オブジェクトの配列が含まれます。コンポーネントはオプションです。テストまたはディストリビューションワークフロー用のコンポーネントなしでレシピを作成できます。

     注記

     Image Builder は、レシピで指定した順序でコンポーネントをインストールします。しかし、CIS のハードニング・コンポーネントは、ベンチマーク・テストが出力イメージに対して実行されるように、常に最後に実行します。

     • コンポーネント ARN (文字列、必須) — コンポーネント ARN。

       ヒント

       例の 1 つを使用して独自のイメージレシピを作成するには、サンプル ARN をレシピに使用しているコンポーネントの ARN に置き換える必要があります。

     • パラメータ (オブジェクトの配列) — ComponentParameter オブジェクトの配列が含まれます。入力パラメータが必須で、コンポーネントにデフォルト値が定義されていない場合は、値を指定する必要があります。必須パラメータのいずれかが不足していてデフォルト値も定義されていない場合、Image Builder はレシピバージョンを作成しません。

       重要

       コンポーネントパラメータはプレーンテキストの値で、 AWS CloudTrailに記録されます。シークレットを保存するには、 AWS Secrets Manager または AWS Systems Manager Parameter Store を使用することをお勧めします。Secrets Manager の詳細については、AWS Secrets Manager ユーザーガイドの Secrets Manager とはを参照してください。 AWS Systems Manager パラメータストアについては、AWS Systems Manager ユーザーガイドのAWS Systems Manager パラメータストアを参照。

       • 名前 (文字列、必須) — 設定するコンポーネントパラメータの名前。

       • 値 (文字列の配列、必須) — 指定されたコンポーネントパラメータの値を設定する文字列の配列を含みます。コンポーネントにデフォルト値が定義されていて、他の値が指定されていない場合、 はデフォルト値 AWSTOE を使用します。

   • amiWatermarks (文字列の配列、オプション) – このレシピから構築された出力 AMIs にアタッチするウォーターマーク名のリスト。ウォーターマークは、イメージの履歴を追跡するのに役立つ系統マーカーです。1～5 の名前を指定します。各名前は 3～128 文字で、文字、数字、スペース、特殊文字 を含めることができます( ) [ ] . / - ' @ _。詳細については、「ウォーターマークを使用して AMI 系統を追跡する」を参照してください。

   • 追加のインスタンス設定 (オブジェクト) — ビルドインスタンス用の追加設定と起動スクリプトを指定します。

     • systemsManagerAgent (オブジェクト) - ビルド・インスタンス上の Systems Manager エージェントの設定が含まれます。

       注記

       Windows レシピは systemsManagerAgent設定をサポートしていません。Windows の親イメージに含めると、リクエストは失敗します。

       • uninstallAfterBuild (Boolean) - 新しい AMI を作成する前に、Systems Manager エージェントを最終ビルド・イメージから削除するかどうかを制御します。これが true に設定されている場合、エージェントは最終イメージから削除されます。オプションがfalseに設定されている場合、エージェントは新しい AMI に含まれるように残され デフォルト値は false です。

         注記

         uninstallAfterBuild 属性が JSON ファイルに含まれておらず、次の条件に当てはまる場合、Image Builder は最終イメージから Systems Manager エージェントを削除し、AMI で使用できないようにします。

         • userDataOverride は空であるか、JSON ファイルから省略されています。

         • Image Builder は、ベースイメージにエージェントがプリインストールされていないオペレーティングシステムのビルドインスタンスに Systems Manager エージェントを自動的にインストールしました。

     • ユーザーデータの上書き (文字列) — 構築インスタンスを起動するときに実行するコマンドまたはコマンドスクリプトを指定します。

       注記

       ユーザーデータは常に Base 64 でエンコードされます。例えば、以下のコマンドは IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg== としてエンコードされます。

       #!/bin/bash
       mkdir -p /var/bb/
       touch /var

       Linux の例では、このエンコードされた値を使用しています。

   Linux

   次の例のベースイメージ (parentImage プロパティ) は AMI です。AMI を使用するときは、その AMI にアクセスできる必要があり、AMI はソースリージョン (Image Builder がコマンドを実行するのと同じリージョン) にある必要があります。ファイルをcreate-image-recipe.jsonの名前で保存し、create-image-recipeコマンドで使用します。

   {
   "name": "BB Ubuntu Image recipe",
   "description": "Hello World image recipe for Linux.",
   "parentImage": "ami-1234567890abcdef1",
   "semanticVersion": "1.0.0",
   "components": [
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/bb$"
   	}
   ],
   "additionalInstanceConfiguration": {
   	"systemsManagerAgent": {
   	 	"uninstallAfterBuild": true
   	},
   	"userDataOverride": "IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg=="
   }
   }

   Windows

   次の例は、Windows Server 2016 英語版フルベースイメージの最新バージョンを参照しています。この例の ARN は、指定したセマンティックバージョンフィルターに基づいて最新のイメージを参照します。 arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x

   {
   "name": "MyBasicRecipe",
   "description": "This example image recipe creates a Windows 2016 image.",
   "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x",
   "semanticVersion": "1.0.0",
   "components": [
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/2019.12.02/1"
   	},
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-imported-component/1.0.0/1"
   	}
   ]
   }

   注記

   Image Builder リソースのセマンティックバージョニングの詳細については、Image Builder でのセマンティックバージョニングを参照してください。

   macOS

   次の例のベースイメージ (parentImage プロパティ) は AMI です。AMI を使用するときは、その AMI にアクセスできる必要があり、AMI はソースリージョン (Image Builder がコマンドを実行するのと同じリージョン) にある必要があります。ファイルをcreate-image-recipe.jsonの名前で保存し、create-image-recipeコマンドで使用します。

   {
   "name": "macOS Catalina Image recipe",
   "description": "Hello World image recipe for macOS.",
   "parentImage": "ami-1234567890abcdef1",
   "semanticVersion": "1.0.0",
   "components": [
   	{
   		"componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/catalina$"
   	}
   ],
   "additionalInstanceConfiguration": {
   	"systemsManagerAgent": {
   	 	"uninstallAfterBuild": true
   	},
   	"userDataOverride": "IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg=="
   }
   }

   例: コンポーネントのないレシピ

   レシピは、既存の AMIsまたはディストリビューション専用のワークフローをテストするためのコンポーネントなしで作成できます。次の例は、追加のコンポーネントを適用せずに既存の AMI を使用するレシピを示しています。

   {
   	"name": "Test Distribution Recipe",
   	"description": "Recipe for testing and distributing existing AMI without modifications.",
   	"parentImage": "ami-1234567890abcdef1",
   	"semanticVersion": "1.0.0",
   	"additionalInstanceConfiguration": {
   		"systemsManagerAgent": {
   		 	"uninstallAfterBuild": true
   		}
   	}
   }

2. レシピを作成する

   レシピを作成するには以下のコマンドを使用します。前のステップで作成した JSON ファイルの名前を --cli-input-json パラメータに入力します。

   aws imagebuilder create-image-recipe --cli-input-json file://create-image-recipe.json

   注記

   • JSON ファイルパスの先頭に file:// 表記を含める必要があります。

   • JSON ファイルのパスは、コマンドを実行するベースオペレーティングシステムに適した規則に従う必要があります。例えば、Windows ではディレクトリパスを表すためにバックスプラッシュ (\) が使用され、Linux と macOS ではフォーワードスラッシュ (/) が使用されます。

   最終イメージには、 AWS Marketplace イメージ製品とコンポーネントから最大 9 つの製品コードを含めることができます。create-image-recipe コマンドの実行時にベースイメージとコンポーネントがこの制限を超えた場合、Image Builder はレシピの作成中にエラーを返します。

   コマンドは、次の出力例に示すように、新しいイメージレシピの ARN を返します。

   {
   	"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
   	"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
   	"imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.1"
   }

3. レシピを検証する

   Image Builder がレシピを期待どおりに作成したことを確認するには、前のステップで返された ARN を使用して get-image-recipe コマンドを実行します。

   aws imagebuilder get-image-recipe --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.1

1. ベースイメージの イメージの選択 セクションで、ベースイメージをインポート オプションを選択します。

2. 通常どおり、イメージオペレーティングシステム (OS) とOS バージョン を選択します。

1. ソース - これは S3 バケットまたは EBS スナップショットのいずれかになります。

2. ディスクの S3 の場所を選択 - ディスクイメージが保存されている Amazon S3 の場所を入力します。場所を参照するには、[S3 を参照] を選択します。

3. ディスクコンテナを追加するには、[ディスクコンテナを追加] を選択します。

General

1. ベースイメージに固有の 名前 を指定します。値を入れない場合、ベースイメージで自動的にレシピ名が継承されます。

2. ベースイメージの バージョン を指定します。形式は以下のようになります: <major>.<minor>.<patch> 値を入力しない場合、ベースイメージはレシピバージョンを継承します。

3. ベースイメージの 説明 を入力することもできます。