CodeBuild aturan - AWS CodePipeline
Izin kebijakan peran layananJenis aturanParameter konfigurasiContoh konfigurasi aturanLihat juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

CodeBuild aturan

Saat Anda membuat kondisi, Anda dapat menambahkan CodeBuild aturan. Bagian ini memberikan referensi untuk parameter aturan. Untuk informasi selengkapnya tentang aturan dan ketentuan, lihatBagaimana kondisi panggung bekerja?.

Anda dapat menggunakan CodeBuild aturan untuk membuat kondisi di mana keberhasilan menjalankan proyek build Anda memenuhi kriteria aturan, seperti build run yang berhasil untuk kondisi beforeEntry.

catatan

Untuk kondisi beforeEntry yang dikonfigurasi dengan hasil Lewati, hanya aturan berikut yang tersedia: LambdaInvoke dan. VariableCheck

Izin kebijakan peran layanan

Untuk izin aturan ini, tambahkan berikut ini ke pernyataan kebijakan peran CodePipeline layanan Anda. Cakupan izin ke tingkat sumber daya.

{
    "Effect": "Allow",
    "Action": [
        "codebuild:BatchGetBuilds",
        "codebuild:StartBuild"
    ],
    "Resource": "resource_ARN"
},

Jenis aturan

  • Kategori: Rule

  • Pemilik: AWS

  • Penyedia: CodeBuild

  • Versi: 1

Parameter konfigurasi

ProjectName

Wajib: Ya

ProjectNameadalah nama proyek pembangunan di CodeBuild.

PrimarySource

Diperlukan: Kondisional

Nilai PrimarySource parameter harus menjadi nama salah satu artefak input untuk tindakan. CodeBuild mencari file buildspec dan menjalankan perintah buildspec di direktori yang berisi versi unzip artefak ini.

Parameter ini diperlukan jika beberapa artefak masukan ditentukan untuk suatu CodeBuild tindakan. Ketika hanya ada satu artefak sumber untuk aksi, artefak default ke PrimarySource artefak itu.

BatchEnabled

Wajib: Tidak

Nilai Boolean dari BatchEnabled parameter memungkinkan tindakan untuk menjalankan beberapa build dalam eksekusi build yang sama.

Ketika opsi ini diaktifkan, CombineArtifacts opsi tersedia.

Untuk contoh pipeline dengan build batch diaktifkan, lihat CodePipeline integrasi dengan CodeBuild dan build batch.

CombineArtifacts

Wajib: Tidak

Nilai Boolean CombineArtifacts parameter menggabungkan semua artefak build dari build batch menjadi file artefak tunggal untuk aksi build.

Untuk menggunakan opsi ini, BatchEnabled parameter harus diaktifkan.

EnvironmentVariables

Wajib: Tidak

Nilai parameter ini digunakan untuk mengatur variabel lingkungan untuk CodeBuild tindakan di pipeline Anda. Nilai untuk EnvironmentVariables parameter mengambil bentuk array JSON dari objek variabel lingkungan. Lihat parameter contoh diDeklarasi tindakan (CodeBuildcontoh).

Setiap objek memiliki tiga bagian, yang semuanya adalah string:

  • name: Nama atau kunci variabel lingkungan.

  • value: Nilai variabel lingkungan. Saat menggunakan SECRETS_MANAGER tipe PARAMETER_STORE atau, nilai ini harus berupa nama parameter yang telah Anda simpan di AWS Systems Manager Parameter Store atau rahasia yang telah Anda simpan di AWS Secrets Manager, masing-masing.

    catatan

    Kami sangat tidak menyarankan penggunaan variabel lingkungan untuk menyimpan nilai sensitif, terutama AWS kredensyal. Saat Anda menggunakan CodeBuild konsol atau AWS CLI, variabel lingkungan ditampilkan dalam teks biasa. Untuk nilai sensitif, kami sarankan Anda menggunakan SECRETS_MANAGER tipe sebagai gantinya.

  • type: (Opsional) Jenis variabel lingkungan. Nilai yang valid adalah PARAMETER_STORE, SECRETS_MANAGER, atau PLAINTEXT. Ketika tidak ditentukan, ini default ke. PLAINTEXT

catatan

Saat Anda memasukkanname,value, dan type untuk konfigurasi variabel lingkungan Anda, terutama jika variabel lingkungan berisi sintaks variabel CodePipeline keluaran, jangan melebihi batas 1000 karakter untuk bidang nilai konfigurasi. Kesalahan validasi dikembalikan ketika batas ini terlampaui.

Untuk informasi selengkapnya, lihat EnvironmentVariabledi Referensi AWS CodeBuild API. Untuk contoh CodeBuild tindakan dengan variabel lingkungan yang menyelesaikan ke nama GitHub cabang, lihat. Contoh: Gunakan BranchName variabel dengan variabel CodeBuild lingkungan

Contoh konfigurasi aturan

YAML
name: codebuild-rule
ruleTypeId:
  category: Rule
  owner: AWS
  provider: CodeBuild
  version: '1'
configuration:
  ProjectName: my-buildproject
  EnvironmentVariables: '[{"name":"VAR1","value":"variable","type":"PLAINTEXT"}]'
inputArtifacts:
- name: SourceArtifact
region: us-east-1
JSON
{
    "name": "codebuild-rule",
    "ruleTypeId": {
        "category": "Rule",
        "owner": "AWS",
        "provider": "CodeBuild",
        "version": "1"
    },
    "configuration": {
        "ProjectName": "my-buildproject"
    },
    "inputArtifacts": [
        {
            "name": "SourceArtifact",
            "EnvironmentVariables": "[{\"name\":\"VAR1\",\"value\":\"variable\",\"type\":\"PLAINTEXT\"}]"
        }
    ],
    "region": "us-east-1"
}

Sumber daya terkait berikut dapat membantu Anda saat Anda bekerja dengan aturan ini.