ステージ宣言

ステージレベルのパイプラインには、以下のパラメータと構文を含む基本構造があります。詳細については、「CodePipeline API ガイド」の「StageDeclaration」オブジェクトを参照してください。

次の例は、ステージレベルのパイプライン構造を JSON と YAML の両方で示しています。この例には、Source および Build という 2 つのステージが含まれています。onSuccess の条件と beforeEntry の条件の 2 つも含まれています。

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:
    - name: Source
      actions:
        - name: Source
          ...
    - name: Build
      actions:
        - name: Build
          ...
      onSuccess:
        conditions:
        - result: ROLLBACK
          rules:
          - name: DeploymentWindowRule
         ...
      beforeEntry:
        conditions:
        - result: FAIL
          rules:
          - name: MyLambdaRule
         ...
  version: 6
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": [
            {
                "name": "Source",
                "actions": [
                    {
                        "name": "Source",
                        ...
                    }
                ]
            },
            {
                "name": "Build",
                "actions": [
                    {
                        "name": "Build",
                        ...
                    }
                ],
                "onSuccess": {
                    "conditions": [
                        {
                            "result": "ROLLBACK",
                            "rules": [
                                {
                                    "name": "DeploymentWindowRule",
                                    ...
                                }
                            ]
                        }
                    ]
                },
                "beforeEntry": {
                    "conditions": [
                        {
                            "result": "FAIL",
                            "rules": [
                                {
                                    "name": "MyLambdaRule",
                                     ...
                                }
                            ]
                        }
                    ]
                }
            }
        ],
            
            }
        ],
        "version": 6
    },
    "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

ステージの名前。

actions

アクションレベルのパイプラインには、以下のパラメータと構文を含む基本構造があります。パラメータと例を表示するには、「アクションの宣言」を参照してください。

conditions

条件には、CodePipeline のルールのリストで使用できる 1 つ以上のルールが含まれます。条件内のすべてのルールが成功すると、条件は満たされます。条件が満たされない場合に、指定した結果が適用されるように、条件を設定できます。

以下のタイプの条件を設定できます。

• beforeEntry

• onFailure

• onSuccess

詳細な説明と例については、「ステージの条件を設定する」を参照してください。

rules

各条件内には、一連の順序付けられたルールがあり、セットとしてまとめて評価されます。したがって、条件内の 1 つのルールが失敗すると、条件は失敗します。ルール条件は、パイプラインのランタイムに上書きできます。

利用可能なルールは、ルールリファレンスに記載しています。詳細については、「ルール構造リファレンス」でルール構造リファレンスを参照してください。