name roleArn artifactStoreATAU artifactStores stages version executionMode pipelineType variables triggers metadata

Deklarasi pipa

Tingkat pipa dan metadata pipa memiliki struktur dasar yang mencakup parameter dan sintaks berikut. Parameter pipa mewakili struktur tindakan dan tahapan yang harus dilakukan dalam pipa.

Untuk informasi selengkapnya, lihat PipelineDeclarationobjek di CodePipeline APIPanduan.

Contoh berikut menunjukkan tingkat pipa dan metadata struktur pipa di keduanya JSON dan YAML untuk pipa tipe V2.

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`

Nama dari alur. Saat Anda mengedit atau memperbarui pipeline, nama pipeline tidak dapat diubah.

catatan

Jika Anda ingin mengganti nama pipeline yang ada, Anda dapat menggunakan CLI get-pipeline perintah untuk membuat JSON file yang berisi struktur pipeline Anda. Anda kemudian dapat menggunakan CLI create-pipeline perintah untuk membuat pipeline dengan struktur itu dan memberinya nama baru.

`roleArn`

IAMARNUntuk peran CodePipeline layanan, seperti arn:aws:iam: :80398:role/ _Service_Role. EXAMPLE CodePipeline

Untuk menggunakan konsol untuk melihat peran layanan pipeline ARN alih-alih JSON struktur, pilih pipeline Anda di konsol, lalu pilih Pengaturan. Di bawah tab Umum, ARN bidang peran Layanan ditampilkan.

`artifactStore`ATAU `artifactStores`

artifactStoreBidang berisi jenis bucket artefak dan lokasi untuk pipeline dengan semua tindakan di AWS Wilayah yang sama. Jika Anda menambahkan tindakan di Wilayah yang berbeda dari pipeline, artifactStores pemetaan akan digunakan untuk mencantumkan bucket artefak untuk setiap AWS Wilayah tempat tindakan dijalankan. Saat membuat atau mengedit pipeline, Anda harus memiliki bucket artefak di Wilayah pipeline dan kemudian Anda harus memiliki satu bucket artefak per Wilayah tempat Anda berencana untuk menjalankan suatu tindakan.

catatan

Dalam struktur pipa, Anda harus memasukkan salah satu artifactStore atau artifactStores dalam pipa Anda, tetapi Anda tidak dapat menggunakan keduanya. Jika Anda membuat tindakan lintas wilayah di alur Anda, Anda harus menggunakan artifactStores.

Contoh berikut menunjukkan struktur dasar untuk pipeline dengan tindakan lintas wilayah yang menggunakan artifactStores parameter:


    "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`

Jenis lokasi untuk bucket artefak, ditentukan sebagai Amazon S3.

`location`

Nama bucket Amazon S3 dibuat secara otomatis untuk Anda saat pertama kali membuat pipeline menggunakan konsol, seperti codepipeline-us-east -2-1234567890, atau bucket Amazon S3 apa pun yang Anda berikan untuk tujuan ini

`stages`

Parameter ini berisi nama setiap tahap dalam pipa. Untuk informasi lebih lanjut tentang parameter dan sintaks pada tingkat tahap struktur pipa, lihat StageDeclarationobjek di CodePipeline APIPanduan.

Struktur pipa untuk tahapan memiliki persyaratan sebagai berikut:

Pipa harus mengandung setidaknya dua tahap.
Tahap pertama dari pipa harus berisi setidaknya satu tindakan sumber. Ini dapat berisi tindakan sumber saja.
Hanya tahap pertama dari pipa yang dapat berisi tindakan sumber.
Setidaknya satu tahap di setiap pipeline harus berisi tindakan yang bukan merupakan tindakan sumber.
Semua nama panggung dalam pipeline harus unik.
Nama panggung tidak dapat diedit di CodePipeline konsol. Jika Anda mengedit nama panggung dengan menggunakan AWS CLI, dan tahap berisi tindakan dengan satu atau beberapa parameter rahasia (seperti OAuth token), nilai parameter rahasia tersebut tidak dipertahankan. Anda harus memasukkan nilai parameter secara manual (yang ditutupi oleh empat tanda bintang di JSON dikembalikan oleh AWS CLI) dan memasukkannya ke dalam struktur. JSON

`version`

Nomor versi pipeline dibuat dan diperbarui secara otomatis setiap kali Anda memperbarui pipeline.

`executionMode`

Anda dapat mengatur mode eksekusi pipeline sehingga Anda dapat menentukan perilaku pipeline untuk menjalankan berturut-turut, seperti antrian, menggantikan, atau menjalankan dalam mode paralel. Untuk informasi selengkapnya, lihat Mengatur atau mengubah mode eksekusi pipa.

`pipelineType`

Jenis pipa menentukan struktur dan fitur yang tersedia dalam pipa, seperti untuk pipa tipe V2. Untuk informasi selengkapnya, lihat Jenis pipa.

`variables`

Variabel pada tingkat pipa didefinisikan ketika pipa dibuat dan diselesaikan pada waktu proses pipa. Untuk informasi selengkapnya, lihat Referensi variabel. Untuk tutorial dengan variabel tingkat pipa yang dilewatkan pada saat eksekusi pipeline, lihat. Tutorial: Gunakan variabel tingkat pipa

`triggers`

Pemicu memungkinkan Anda mengonfigurasi pipeline untuk memulai pada jenis peristiwa tertentu atau jenis peristiwa yang difilter, seperti saat perubahan pada cabang tertentu atau permintaan tarik terdeteksi. Pemicu dapat dikonfigurasi untuk tindakan sumber dengan koneksi yang menggunakan CodeStarSourceConnection tindakan di CodePipeline, seperti, Bitbucket GitHub, dan. GitLab Untuk informasi selengkapnya tentang tindakan sumber yang menggunakan koneksi, lihatConnect ke penyedia sumber pihak ketiga menggunakan CodeConnections.

Untuk informasi selengkapnya, lihat Otomatiskan saluran pipa awal menggunakan pemicu dan penyaringan.

catatan

Tindakan sumber CodeCommit dan S3 memerlukan sumber daya deteksi perubahan yang dikonfigurasi ( EventBridge aturan) atau menggunakan opsi untuk melakukan polling repositori untuk perubahan sumber. Untuk pipeline dengan Bitbucket, GitHub, atau tindakan sumber Server GitHub Perusahaan, Anda tidak perlu menyiapkan webhook atau default untuk polling. Tindakan koneksi mengelola deteksi perubahan untuk Anda.

`metadata`

Bidang metadata pipa berbeda dari struktur pipa dan tidak dapat diedit. Saat Anda memperbarui pipeline, tanggal di bidang updated metadata berubah secara otomatis.

`pipelineArn`

Nama Sumber Daya Amazon (ARN) dari pipeline.

Untuk menggunakan konsol untuk melihat pipeline ARN alih-alih JSON struktur, pilih pipeline Anda di konsol, lalu pilih Pengaturan. Di bawah tab Umum, ARN bidang Pipeline ditampilkan.

`created`

Tanggal dan waktu ketika pipa dibuat.

`updated`

Tanggal dan waktu ketika pipa terakhir diperbarui.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Referensi struktur pipa

Deklarasi tahap