CodeCommit ソースの EventBridge ルールを作成する (CLI)

put-rule コマンドを呼び出して、以下を指定します。

• 作成中のルールを一意に識別する名前。この名前は、 AWS アカウント CodePipeline に関連付けられた で作成するすべてのパイプラインで一意である必要があります。

• ルールで使用するソースと詳細フィールドのイベントパターン。詳細については、「Amazon EventBridge とイベントパターン」を参照してください。

をイベントソース CodeCommit として、 をターゲット CodePipeline として EventBridge ルールを作成するには

1. ルールの呼び出し EventBridge に使用する CodePipeline のアクセス許可を追加します。詳細については、「Amazon のリソースベースのポリシーの使用 EventBridge」を参照してください。

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

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

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

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

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

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

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

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

      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 パラメータを含めます。

   この変更を行う理由 このコマンドでは、 AWS CloudFormation でイベントを作成することができます。

   次のサンプルコマンドは、MyCodeCommitRepoRule というルールを作成します。

   aws events put-rule --name "MyCodeCommitRepoRule" --event-pattern "{\"source\":[\"aws.codecommit\"],\"detail-type\":[\"CodeCommit Repository State Change\"],\"resources\":[\"repository-ARN\"],\"detail\":{\"referenceType\":[\"branch\"],\"referenceName\":[\"main\"]}}" --role-arn "arn:aws:iam::ACCOUNT_ID:role/Role-for-MyRule"

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

   • --rule パラメータは、put-rule を使用して作成した rule_name で使用されます。

   • --targets パラメータは、ターゲットリストのリスト Id とターゲットパイプラインの ARN で使用されます。

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

   aws events put-targets --rule MyCodeCommitRepoRule --targets Id=1,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 ファイルを開き、以下に示しているように、PollForSourceChanges パラメータを false に変更してソースステージを編集します。

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

   "configuration": {
       "PollForSourceChanges": "false",
       "BranchName": "main",
       "RepositoryName": "MyTestRepo"
   },

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 コマンドを使用します。