イベントに対して S3 ソースを有効にしてパイプラインを作成する (CLI)

変更検出のために EventBridge のイベントを使用する S3 ソースを使用してパイプラインを作成するには、次の手順に従います。CLI を使用してパイプラインを作成する詳細な手順については、「」を参照してくださいパイプライン、ステージ、アクションを作成する。

Amazon S3 でイベント駆動型パイプラインを構築するには、パイプラインの PollForSourceChanges パラメータを編集してから、以下のリソースを作成します。

• EventBridge イベントバス

• EventBridge イベントによるパイプラインの開始を許可する IAM ロール

Amazon S3 をイベントソース、CodePipeline をターゲットとする EventBridge ルールを作成し、アクセス許可ポリシーを適用するには

1. EventBridge が CodePipeline を使用してルールを呼び出すためのアクセス許可を付与します。詳細については、 デベロッパーガイドの [Amazon EventBridge のリソースベースのポリシーを使用する] を参照してください。

   1. 次のサンプルを使用して、EventBridge にサービスロールの引き受けを許可する信頼ポリシーを作成します。このスクリプトに trustpolicyforEB.json という名前を付けます。

      JSON

      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [
              {
                  "Effect": "Allow",
                  "Principal": {
                      "Service": "events.amazonaws.com"
                  },
                  "Action": "sts:AssumeRole"
              }
          ]
      }
      

   2. 次のコマンドを使用して、Role-for-MyRule ロールを作成し、信頼ポリシーをアタッチします。

      この変更を行う理由 ロールにこの信頼ポリシーを追加すると、EventBridge に対するアクセス許可が作成されます。

      aws iam create-role --role-name Role-for-MyRule --assume-role-policy-document file://trustpolicyforEB.json

   3. 次に示すように、MyFirstPipeline という名前のパイプラインに対してアクセス許可ポリシー JSON を作成します。アクセス権限ポリシーに permissionspolicyforEB.json と名前を付けます。

      JSON

      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [
              {
                  "Effect": "Allow",
                  "Action": [
                      "codepipeline:StartPipelineExecution"
                  ],
                  "Resource": [
                      "arn:aws:codepipeline:us-west-2:111122223333:MyFirstPipeline"
                  ]
              }
          ]
      }
      

   4. 次のコマンドを実行して、作成した Role-for-MyRule ロールに新しい CodePipeline-Permissions-Policy-for-EB アクセス権限ポリシーをアタッチします。

      aws iam put-role-policy --role-name Role-for-MyRule --policy-name CodePipeline-Permissions-Policy-For-EB --policy-document file://permissionspolicyforEB.json

2. put-rule コマンドを呼び出し、--name、--event-pattern、--role-arn パラメータを含めます。

   次のサンプルコマンドでは、EnabledS3SourceRule という名前のルールが作成されます。

   aws events put-rule --name "EnabledS3SourceRule" --event-pattern "{\"source\":[\"aws.s3\"],\"detail-type\":[\"Object Created\"],\"detail\":{\"bucket\":{\"name\":[\"amzn-s3-demo-source-bucket\"]}}}" --role-arn "arn:aws:iam::ACCOUNT_ID:role/Role-for-MyRule"

3. CodePipeline をターゲットとして追加するには、put-targets コマンドを呼び出し、--rule および --targets パラメータを含めます。

   次のコマンドでは、EnabledS3SourceRule という名前のルールに対して指定し、ターゲット Id は 1 番で構成されています。これは、ルールのターゲットのリストが何であるかを示し、この場合は ターゲット 1 です。このコマンドでは、パイプラインのサンプルの ARN も指定されます。パイプラインは、リポジトリ内に変更が加えられると開始します。

   aws events put-targets --rule EnabledS3SourceRule --targets Id=codepipeline-AppPipeline,Arn=arn:aws:codepipeline:us-west-2:80398EXAMPLE:TestPipeline

パイプラインの PollForSourceChanges パラメータを編集するには

重要

このメソッドを使用してパイプラインを作成すると、PollForSourceChanges パラメータはデフォルトで true になります (ただし、明示的に false に設定した場合は除きます)。イベントベースの変更検出を追加する場合は、このパラメータを出力に追加する必要があります。ポーリングを無効にするには、このパラメータを false に設定します。そうしないと、1 つのソース変更に対してパイプラインが 2 回起動されます。詳細については、「PollForSourceChanges パラメータの有効な設定」を参照してください

1. get-pipeline コマンドを実行して、パイプライン構造を JSON ファイルにコピーします。例えば、MyFirstPipeline という名前のパイプラインに対して、以下のコマンドを実行します。

   aws codepipeline get-pipeline --name MyFirstPipeline >pipeline.json

   このコマンドは何も返しませんが、作成したファイルは、コマンドを実行したディレクトリにあります。

2. この例に示すように、プレーンテキストエディタでJSONファイルを開き、amzn-s3-demo-source-bucket という名前のバケットの PollForSourceChanges パラメータを false に変更してソースステージを編集します。

   この変更を行う理由 このパラメータを false に設定すると、定期的チェックがオフになるため、イベントベースの変更検出のみ使用することができます。

   "configuration": {
       "S3Bucket": "amzn-s3-demo-source-bucket",
       "PollForSourceChanges": "false",
       "S3ObjectKey": "index.zip"
   },

3. get-pipeline コマンドを使用して取得したパイプライン構造を使用している場合、JSON ファイルから metadata 行を削除する必要があります。それ以外の場合は、update-pipeline コマンドで使用することはできません。"metadata": { } 行と、"created"、"pipelineARN"、"updated" フィールドを削除します。

   例えば、構造から以下の行を削除します。

   "metadata": {
       "pipelineArn": "arn:aws:codepipeline:region:account-ID:pipeline-name",
       "created": "date",
       "updated": "date"
   },

   ファイルを保存します。

4. 変更を適用するには、パイプライン JSON ファイルを指定して、update-pipeline コマンドを実行します。

   重要

   ファイル名の前に必ず file:// を含めてください。このコマンドでは必須です。

   aws codepipeline update-pipeline --cli-input-json file://pipeline.json

   このコマンドは、編集したパイプラインの構造全体を返します。

   注記

   update-pipeline コマンドは、パイプラインを停止します。update-pipeline コマンドを実行したときにパイプラインによりリビジョンが実行されている場合、その実行は停止します。更新されたパイプラインによりそのリビジョンを実行するには、パイプラインを手動で開始する必要があります。パイプラインを手動で開始するには start-pipeline-execution コマンドを使用します。