Referensi variabel

Bagian ini hanya referensi. Untuk informasi tentang membuat variabel, lihatBekerja dengan variabel.

Variabel memungkinkan Anda mengonfigurasi tindakan pipeline Anda dengan nilai yang ditentukan pada saat eksekusi pipeline atau eksekusi tindakan.

Beberapa penyedia tindakan menghasilkan serangkaian variabel yang ditentukan. Anda memilih dari kunci variabel default untuk penyedia tindakan tersebut, seperti Commit ID.

Untuk melihat contoh langkah demi langkah menggunakan variabel:

Batas Variabel

Untuk informasi batas, lihatKuota di AWS CodePipeline.

Konsep

Bagian ini mencantumkan istilah dan konsep kunci yang terkait dengan variabel dan ruang nama.

Variabel

Variabel adalah pasangan kunci-nilai yang dapat digunakan untuk mengonfigurasi tindakan secara dinamis dalam pipeline Anda. Saat ini ada tiga cara variabel ini tersedia:

Untuk mereferensikan variabel-variabel ini dalam konfigurasi tindakan Anda, Anda harus menggunakan sintaks referensi variabel dengan namespace yang benar.

Untuk contoh alur kerja variabel, lihatMengkonfigurasi variabel.

Namespace

Untuk memastikan bahwa variabel dapat direferensikan secara unik, mereka harus ditetapkan ke namespace. Setelah Anda memiliki sekumpulan variabel yang ditetapkan ke namespace, mereka dapat direferensikan dalam konfigurasi tindakan dengan menggunakan namespace dan kunci variabel dengan sintaks berikut:

#{namespace.variable_key}

Ada tiga jenis ruang nama di mana variabel dapat ditetapkan:

Gunakan kasus untuk variabel

Berikut ini adalah beberapa kasus penggunaan yang paling umum untuk variabel di tingkat pipeline, membantu Anda menentukan bagaimana Anda dapat menggunakan variabel untuk kebutuhan spesifik Anda.

Mengkonfigurasi variabel

Anda dapat mengonfigurasi variabel pada tingkat pipeline atau tingkat tindakan dalam struktur pipeline.

Mengkonfigurasi variabel di tingkat pipeline

Anda dapat menambahkan satu atau lebih variabel di tingkat pipeline. Anda dapat mereferensikan nilai ini dalam konfigurasi CodePipeline tindakan. Anda dapat menambahkan nama variabel, nilai default, dan deskripsi saat Anda membuat pipeline. Variabel diselesaikan pada saat eksekusi.

Anda menyediakan variabel pada tingkat pipeline menggunakan atribut variabel dalam struktur pipeline. Dalam contoh berikut, variabel Variable1 memiliki nilaiValue1.

       "variables": [
            {
                "name": "Variable1",
                "defaultValue": "Value1",
                "description": "description"
            }
        ]

Untuk contoh dalam struktur JSON pipeline, lihatBuat pipeline, tahapan, dan tindakan.

Untuk tutorial dengan variabel tingkat pipeline yang dilewatkan pada saat eksekusi pipeline, lihat. Tutorial: Gunakan variabel tingkat pipa

Perhatikan bahwa menggunakan variabel tingkat pipeline dalam segala jenis tindakan Sumber tidak didukung.

Mengkonfigurasi variabel pada tingkat tindakan

Anda mengonfigurasi tindakan untuk menghasilkan variabel dengan mendeklarasikan namespace untuk tindakan tersebut. Tindakan harus sudah menjadi salah satu penyedia tindakan yang menghasilkan variabel. Jika tidak, variabel yang tersedia adalah variabel tingkat pipa.

Anda mendeklarasikan namespace dengan:

Dalam contoh ini, Anda menambahkan namespace parameter ke tindakan CodeCommit sumber dengan namaSourceVariables. Ini mengonfigurasi tindakan untuk menghasilkan variabel yang tersedia untuk penyedia tindakan tersebut, sepertiCommitId.

{
    "name": "Source",
    "actions": [
        {
            "outputArtifacts": [
                {
                    "name": "SourceArtifact"
                }
            ],
            "name": "Source",
            "namespace": "SourceVariables",
            "configuration": {
                "RepositoryName": "MyRepo",
                "BranchName": "mainline",
                "PollForSourceChanges": "false"
            },
            "inputArtifacts": [],
            "region": "us-west-2",
            "actionTypeId": {
                "provider": "CodeCommit",
                "category": "Source",
                "version": "1",
                "owner": "AWS"
            },
            "runOrder": 1
        }
    ]
},

Selanjutnya, Anda mengonfigurasi tindakan hilir untuk menggunakan variabel yang dihasilkan oleh tindakan sebelumnya. Anda melakukan ini dengan:

Dalam contoh ini, bidang konfigurasi tindakan build menunjukkan variabel lingkungan yang diperbarui pada eksekusi tindakan. Contoh menentukan namespace dan variabel untuk ID eksekusi dengan #{codepipeline.PipelineExecutionId} dan namespace dan variabel untuk commit ID dengan. #{SourceVariables.CommitId}

{
    "name": "Build",
    "actions": [
        {
            "outputArtifacts": [
                {
                    "name": "BuildArtifact"
                }
            ],
            "name": "Build",
            "configuration": {
                "EnvironmentVariables": "[{\"name\":\"Release_ID\",\"value\":\"#{codepipeline.PipelineExecutionId}\",\"type\":\"PLAINTEXT\"},{\"name\":\"Commit_ID\",\"value\":\"#{SourceVariables.CommitId}\",\"type\":\"PLAINTEXT\"}]",
                "ProjectName": "env-var-test"
            },
            "inputArtifacts": [
                {
                    "name": "SourceArtifact"
                }
            ],
            "region": "us-west-2",
            "actionTypeId": {
                "provider": "CodeBuild",
                "category": "Build",
                "version": "1",
                "owner": "AWS"
            },
            "runOrder": 1
        }
    ]
},

Resolusi variabel

Setiap kali tindakan dijalankan sebagai bagian dari eksekusi pipeline, variabel yang dihasilkannya tersedia untuk digunakan dalam tindakan apa pun yang dijamin terjadi setelah tindakan produksi. Untuk menggunakan variabel-variabel ini dalam tindakan konsumsi, Anda dapat menambahkannya ke konfigurasi tindakan konsumsi menggunakan sintaks yang ditunjukkan pada contoh sebelumnya. Sebelum melakukan tindakan yang memakan waktu CodePipeline , menyelesaikan semua referensi variabel yang ada dalam konfigurasi sebelum memulai eksekusi tindakan.

Aturan untuk variabel

Aturan berikut membantu Anda dengan konfigurasi variabel:

Variabel yang tersedia untuk tindakan pipeline

Penyedia tindakan menentukan variabel mana yang dapat dihasilkan oleh tindakan.

Untuk prosedur langkah demi langkah untuk mengelola variabel, lihatBekerja dengan variabel.

Tindakan dengan kunci variabel yang ditentukan

Tidak seperti namespace yang dapat Anda pilih, tindakan berikut menggunakan kunci variabel yang tidak dapat diedit. Misalnya, untuk penyedia tindakan Amazon S3, hanya kunci VersionId variabel ETag dan yang tersedia.

Setiap eksekusi juga memiliki satu set variabel CodePipeline-generated pipeline yang berisi data tentang eksekusi, seperti ID rilis pipeline. Variabel-variabel ini dapat dikonsumsi oleh tindakan apa pun dalam pipeline.

CodePipeline variabel ID eksekusi

Variabel keluaran tindakan Amazon ECR

CloudFormation StackSets variabel keluaran tindakan

CodeCommit variabel keluaran tindakan

CodeStarSourceConnection variabel keluaran tindakan

Variabel output yang tersedia tergantung pada jenis pemicu (push, pull request, atau tag). Variabel dalam tabel berikut ditandai sebagai Semua diproduksi untuk setiap jenis pemicu. Variabel yang ditandai dengan jenis pemicu tertentu hanya dihasilkan ketika eksekusi pipeline dimulai oleh pemicu itu.

GitHub variabel keluaran tindakan (GitHub (melalui aplikasi OAuth) tindakan)

Variabel keluaran tindakan S3

Tindakan dengan tombol variabel yang dikonfigurasi pengguna

Untuk tindakan CodeBuild CloudFormation,, dan Lambda, kunci variabel dikonfigurasi oleh pengguna.

CloudFormation variabel keluaran tindakan

CodeBuild variabel keluaran tindakan

#{BuildVariables.EnvVar}

Variabel keluaran tindakan lambda