CodeCommit ソースに対する EventBridge ルールを作成する (CloudFormation テンプレート)

CloudFormation を使用してルールを作成するには、ここで示しているようにテンプレートを更新します。

パイプラインの CloudFormation テンプレートを更新し、EventBridge ルールを作成する

テンプレートの Resources で、AWS::IAM::RoleCloudFormation リソースを使用して、イベントにパイプラインの開始を許可する IAM ロールを設定します。このエントリによって、2 つのポリシーを使用するロールが作成されます。

最初のポリシーでは、ロールを引き受けることを許可します。
2 つめのポリシーでは、パイプラインを開始するアクセス権限が付与されます。

この変更を行う理由 AWS::IAM::Role リソースを追加すると、CloudFormation は EventBridge に対してアクセス許可を作成できるようになります。このリソースは CloudFormation スタックに追加されます。

テンプレートの Resources で、AWS::Events::Rule CloudFormation リソースを使用して EventBridge ルールを追加します。このイベントパターンは、リポジトリへの変更のプッシュをモニタリングするイベントを作成します。EventBridge でリポジトリの状態の変更が検出されると、ルールはターゲットパイプラインで StartPipelineExecution を呼び出します。

この変更を行う理由 AWS::Events::Rule リソースを追加すると、CloudFormation でイベントを作成できるようになります。このリソースは CloudFormation スタックに追加されます。

YAML


  EventRule:
    Type: AWS::Events::Rule
    Properties:
      EventPattern:
        source:
          - aws.codecommit
        detail-type:
          - 'CodeCommit Repository State Change'
        resources:
          - !Join [ '', [ 'arn:aws:codecommit:', !Ref 'AWS::Region', ':', !Ref 'AWS::AccountId', ':', !Ref RepositoryName ] ]
        detail:
          event:
            - referenceCreated
            - referenceUpdated
          referenceType:
            - branch
          referenceName:
            - main
      Targets:
        -
          Arn: 
            !Join [ '', [ 'arn:aws:codepipeline:', !Ref 'AWS::Region', ':', !Ref 'AWS::AccountId', ':', !Ref AppPipeline ] ]
          RoleArn: !GetAtt EventRole.Arn
          Id: codepipeline-AppPipeline

JSON



"EventRule": {
  "Type": "AWS::Events::Rule",
  "Properties": {
    "EventPattern": {
      "source": [
        "aws.codecommit"
      ],
      "detail-type": [
        "CodeCommit Repository State Change"
      ],
      "resources": [
        {
          "Fn::Join": [
            "",
            [
              "arn:aws:codecommit:",
              {
                "Ref": "AWS::Region"
              },
              ":",
              {
                "Ref": "AWS::AccountId"
              },
              ":",
              {
                "Ref": "RepositoryName"
              }
            ]
          ]
        }
      ],
      "detail": {
        "event": [
          "referenceCreated",
          "referenceUpdated"
        ],
        "referenceType": [
          "branch"
        ],
        "referenceName": [
          "main"
        ]
      }
    },
    "Targets": [
      {
        "Arn": {
          "Fn::Join": [
            "",
            [
              "arn:aws:codepipeline:",
              {
                "Ref": "AWS::Region"
              },
              ":",
              {
                "Ref": "AWS::AccountId"
              },
              ":",
              {
                "Ref": "AppPipeline"
              }
            ]
          ]
        },
        "RoleArn": {
          "Fn::GetAtt": [
            "EventRole",
            "Arn"
          ]
        },
        "Id": "codepipeline-AppPipeline"
      }
    ]
  }
},

(オプション) 特定のイメージ ID のソースオーバーライドを使用して入力トランスフォーマーを設定するには、次の YAML スニペットを使用します。次の例では、以下のオーバーライドを設定します。
- actionName は (この例では Source)、ソースイベントから派生したものではなく、パイプラインの作成時に定義された動的な値です。
- revisionType は (この例では COMMIT_ID)、ソースイベントから派生したものではなく、パイプラインの作成時に定義された動的な値です。
- revisionValue は (この例では <revisionValue>)、ソースイベント変数から派生しています。
- BranchName および Value の出力変数が指定されます。
```
Rule: my-rule
Targets:
- Id: MyTargetId
  Arn: pipeline-ARN
  InputTransformer:
    sourceRevisions:
      actionName: Source
      revisionType: COMMIT_ID
      revisionValue: <revisionValue>
    variables:
    - name: BranchName
      value: value
```
更新したテンプレートをローカルコンピュータに保存し、CloudFormation コンソールを開きます。
スタックを選択し、[既存スタックの変更セットの作成] を選択します。
テンプレートをアップロードし、CloudFormation に示された変更を表示します。これらがスタックに加えられる変更です。新しいリソースがリストに表示されています。
[実行] を選択してください。

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

重要

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

テンプレートで、PollForSourceChanges を false に変更します。パイプライン定義に PollForSourceChanges が含まれていなかった場合は、追加して false に設定します。

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

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

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

ドキュメントの表記規則

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

CodeConnections を使用してサードパーティのソースプロバイダーを追加する