パイプライン宣言 - AWS CodePipeline
nameroleArnartifactStore または artifactStoresstagesversionexecutionModepipelineTypevariablestriggersmetadata

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

パイプライン宣言

パイプラインのパイプラインとメタデータレベルには、次のパラメータと構文を含む基本的な構造があります。パイプラインパラメータは、パイプラインで実行されるアクションとステージの構造を表します。

詳細については、「 ガイド」のPipelineDeclaration「 オブジェクト」を参照してください。 CodePipeline API

次の例は、YAMLV2 タイプのパイプラインの JSON と の両方のパイプライン構造のパイプラインとメタデータレベルを示しています。

YAML
pipeline:
  name: MyPipeline
  roleArn: >-
    arn:aws:iam::ACCOUNT_ID:role/service-role/AWSCodePipelineServiceRole-us-west-2-MyPipeline
  artifactStore:
    type: S3
    location: amzn-s3-demo-bucket
  stages:
    ...
  version: 6
  executionMode: SUPERSEDED
  pipelineType: V2
  variables:
  - name: MyVariable
    defaultValue: '1'
  triggers:
  - providerType: CodeStarSourceConnection
    gitConfiguration:
      sourceActionName: Source
      push:
      - branches:
          includes:
          - main
          excludes:
          - feature-branch
      pullRequest:
      - events:
        - CLOSED
        branches:
          includes:
          - main*
metadata:
  pipelineArn: 'arn:aws:codepipeline:us-west-2:ACCOUNT_ID:MyPipeline'
  created: '2019-12-12T06:49:02.733000+00:00'
  updated: '2020-09-10T06:34:07.447000+00:00'
JSON
{
    "pipeline": {
        "name": "MyPipeline",
        "roleArn": "arn:aws:iam::ACCOUNT_ID:role/service-role/AWSCodePipelineServiceRole-us-west-2-MyPipeline",
        "artifactStore": {
            "type": "S3",
            "location": "amzn-s3-demo-bucket"
        },
        "stages": {
            ...   
    },
        "version": 6,
        "executionMode": "SUPERSEDED",
                "pipelineType": "V2",
        "variables": [
            {
                "name": "MyVariable",
                "defaultValue": "1"
            }
        ],
        "triggers": [
            {
                "providerType": "CodeStarSourceConnection",
                "gitConfiguration": {
                    "sourceActionName": "Source",
                    "push": [
                        {
                            "branches": {
                                "includes": [
                                    "main"
                                ],
                                "excludes": [
                                    "feature-branch"
                                ]
                            }
                        }
                    ],
                    "pullRequest": [
                        {
                            "events": [
                                "CLOSED"
                            ],
                            "branches": {
                                "includes": [
                                    "main*"
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    },
    "metadata": {
        "pipelineArn": "arn:aws:codepipeline:us-west-2:ACCOUNT_ID:MyPipeline",
        "created": "2019-12-12T06:49:02.733000+00:00",
        "updated": "2020-09-10T06:34:07.447000+00:00"
    }
}

name

パイプラインの名前。パイプラインを編集または更新する場合、パイプライン名は変更できません。

注記

既存のパイプラインの名前を変更する場合は、 CLI get-pipeline コマンドを使用して、パイプラインの構造を含むJSONファイルを構築できます。その後、 CLI create-pipeline コマンドを使用して、その構造でパイプラインを作成し、新しい名前を付けることができます。

roleArn

arn:aws:iam::80398EXAMPLE:role/CodePipeline_Service_Role などの CodePipeline サービスロールIAMARNの 。

コンソールを使用して JSON構造ARNではなくパイプラインサービスロールを表示するには、コンソールでパイプラインを選択し、設定 を選択します。全般タブに、サービスロールARNフィールドが表示されます。

artifactStore または artifactStores

artifactStore フィールドには、同じ AWS リージョン内のすべてのアクションを持つパイプラインのアーティファクトバケットタイプと場所が含まれます。パイプラインとは異なるリージョンにアクションを追加すると、artifactStoresマッピングを使用して、アクションが実行される各 AWS リージョンのアーティファクトバケットを一覧表示します。パイプラインを作成または編集する場合は、パイプラインリージョンにアーティファクトバケットが必要であり、アクションを実行する予定のリージョンごとに 1 つのアーティファクトバケットが必要です。

注記

パイプライン構造では、 artifactStoreまたは をパイプラインartifactStoresに含める必要がありますが、両方を使用することはできません。パイプラインでクロスリージョンアクションを作成する場合は、artifactStores を使用する必要があります。

以下の例では、artifactStores パラメータを使用するクロスリージョンアクションを含むパイプラインの基本構造を示しています。

    "pipeline": {
        "name": "YourPipelineName",
        "roleArn": "CodePipeline_Service_Role",
        "artifactStores": {
            "us-east-1": {
                "type": "S3",
                "location": "S3 artifact bucket name, such as amzn-s3-demo-bucket"
            },
            "us-west-2": {
                "type": "S3",
                "location": "S3 artifact bucket name, such as amzn-s3-demo-bucket"
            }
        },
        "stages": [
            {

...

type

Amazon S3 として指定されたアーティファクトバケットの場所タイプ。

location

コンソールを使用してパイプラインを初めて作成するときに自動的に生成される Amazon S3 バケットの名前。 codepipeline-us-east-2-1234567890、またはこの目的のためにプロビジョニングする Amazon S3 バケットなど。

stages

このパラメータには、パイプラインの各ステージの名前が含まれます。パイプライン構造のステージレベルでのパラメータと構文の詳細については、 CodePipeline API「 ガイド」のStageDeclaration「 オブジェクト」を参照してください。

ステージのパイプライン構造には、次の要件があります。

  • パイプラインには、少なくとも 2 つのステージが含まれている必要がある

  • パイプラインの最初のステージには、少なくとも 1 つのソースアクションが含まれている必要がある ソースアクションのみを含めることができる

  • ソースアクションを含むことができるのは、パイプラインの最初のステージのみである

  • 各パイプラインの少なくとも 1 つのステージに、ソースアクション以外のアクションが含まれている必要がある

  • パイプライン内のすべてのステージ名は一意である必要がある

  • ステージ名は CodePipeline コンソールで編集できません。を使用してステージ名を編集し AWS CLI、ステージに 1 つ以上のシークレットパラメータ (OAuthトークンなど) を含むアクションが含まれている場合、それらのシークレットパラメータの値は保持されません。パラメータの値 ( によってJSON返される に 4 つのアスタリスクでマスクされます AWS CLI) を手動で入力し、 JSON構造に含める必要があります。

version

パイプラインのバージョン番号は自動的に生成され、パイプラインを更新するたびに更新されます。

executionMode

パイプライン実行モードを設定して、キューイング、置き換え、並列モードでの実行など、連続する実行のパイプライン動作を指定できます。詳細については、「パイプライン実行モードを設定または変更する」を参照してください。

pipelineType

パイプラインタイプは、V2 タイプのパイプラインなど、パイプラインで使用可能な構造と機能を指定します。詳細については、「パイプラインのタイプ」を参照してください。

variables

パイプラインレベルの変数は、パイプラインの作成時に定義され、パイプラインの実行時に解決されます。詳細については、「変数リファレンス」を参照してください。パイプラインの実行時に渡されるパイプラインレベルの変数のチュートリアルについては、「チュートリアル: パイプラインレベルの変数を使用する」を参照してください。

triggers

トリガーを使用すると、特定のブランチまたはプルリクエストの変更が検出されたときなど、特定のイベントタイプまたはフィルタリングされたイベントタイプで開始するようにパイプラインを設定できます。トリガーは、 GitHub、Bitbucket CodePipeline、 などの アクションを使用する接続を持つソースCodeStarSourceConnectionアクションに対して設定できます GitLab。接続を使用するソースアクションの詳細については、「」を参照してくださいを使用してサードパーティーのソースプロバイダーに接続する CodeConnections。

詳細については、「トリガーとフィルタリングを使用して開始パイプラインを自動化する」を参照してください。

注記

CodeCommit および S3 ソースアクションには、設定された変更検出リソース ( EventBridge ルール) または オプションを使用して、ソースの変更についてリポジトリをポーリングする必要があります。Bitbucket GitHubまたは GitHub Enterprise Server ソースアクションを持つパイプラインの場合、ウェブフックまたはデフォルトをポーリングに設定する必要はありません。接続アクションは、変更検出を管理します。

metadata

パイプラインメタデータフィールドはパイプライン構造とは異なり、編集することはできません。パイプラインを更新すると、updated メタデータフィールドの日付が自動的に変更されます。

pipelineArn

パイプラインの Amazon リソースネーム (ARN）。

コンソールを使用してJSON構造ARNではなくパイプラインを表示するには、コンソールでパイプラインを選択し、設定 を選択します。全般タブにパイプラインARNフィールドが表示されます。

created

パイプラインが作成された日時。

updated

パイプラインが最後に更新された日時。