CDKBootstrapAction Identifier DependsOn Compute Type Fleet Timeout Inputs Sources Artifacts - input Outputs Artifacts - output Name Files Environment Name Connections Name Role Configuration Region CdkCliVersion

Tindakan 'AWS CDK bootstrap' YAML

Berikut ini adalah YAML definisi dari tindakan AWS CDK bootstrap. Untuk mempelajari cara menggunakan tindakan ini, lihatBootstrapping AWS CDK aplikasi dengan alur kerja.

Definisi tindakan ini ada sebagai bagian dalam file definisi alur kerja yang lebih luas. Untuk informasi selengkapnya tentang file ini, lihatDefinisi alur kerja YAML.

catatan

Sebagian besar YAML properti yang mengikuti memiliki elemen UI yang sesuai di editor visual. Untuk mencari elemen UI, gunakan Ctrl+F. Elemen akan terdaftar dengan YAML properti terkait.


# The workflow definition starts here.
# See Properti tingkat atas for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  CDKBootstrapAction_nn: 
    Identifier: aws/cdk-bootstrap@v2
    DependsOn:
      - action-name
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - artifact-name
    Outputs:
      Artifacts:
        - Name: cdk_bootstrap_artifacts
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      Region: us-west-2
      CdkCliVersion: version

CDKBootstrapAction

(Diperlukan)

Tentukan nama tindakan. Semua nama tindakan harus unik dalam alur kerja. Nama aksi terbatas pada karakter alfanumerik (a-z, A-Z, 0-9), tanda hubung (-), dan garis bawah (_). Spasi tidak diizinkan. Anda tidak dapat menggunakan tanda kutip untuk mengaktifkan karakter dan spasi khusus dalam nama tindakan.

Default: CDKBootstrapAction_nn.

UI yang sesuai: Tab konfigurasi/Nama tampilan tindakan

Identifier

(CDKBootstrapAction/Identifier)

(Diperlukan)

Mengidentifikasi tindakan. Jangan mengubah properti ini kecuali Anda ingin mengubah versi. Untuk informasi selengkapnya, lihat Menentukan versi tindakan yang akan digunakan.

catatan

Menentukan aws/cdk-bootstrap@v2 menyebabkan tindakan berjalan pada gambar Maret 2024 yang menyertakan perkakas yang lebih baru seperti Node.js 18. Menentukan aws/cdk-bootstrap@v1 menyebabkan tindakan berjalan pada gambar November 2022 yang menyertakan perkakas lama seperti Node.js 16.

Default: aws/cdk-bootstrap@v2.

UI yang sesuai: Diagram alur CDKBootstrapAction kerja/_nn/ aws/cdk-bootstrap @v2 label

DependsOn

(CDKBootstrapAction/DependsOn)

(Opsional)

Tentukan tindakan, grup tindakan, atau gerbang yang harus berjalan dengan sukses agar tindakan ini berjalan.

Untuk informasi selengkapnya tentang fungsionalitas 'tergantung pada', lihat. Tindakan pengurutan

UI yang sesuai: Tab masukan/Tergantung pada - opsional

Compute

(CDKBootstrapAction/Compute)

(Opsional)

Mesin komputasi yang digunakan untuk menjalankan tindakan alur kerja Anda. Anda dapat menentukan komputasi baik di tingkat alur kerja atau di tingkat tindakan, tetapi tidak keduanya. Ketika ditentukan pada tingkat alur kerja, konfigurasi komputasi berlaku untuk semua tindakan yang ditentukan dalam alur kerja. Pada tingkat alur kerja, Anda juga dapat menjalankan beberapa tindakan pada instance yang sama. Untuk informasi selengkapnya, lihat Berbagi komputasi di seluruh tindakan.

UI yang sesuai: tidak ada

Type

(CDKBootstrapAction/Compute/Type)

(Diperlukan Compute jika disertakan)

Jenis mesin komputasi. Anda dapat menggunakan salah satu nilai berikut:

EC2(editor visual) atau EC2 (YAMLeditor)

Dioptimalkan untuk fleksibilitas selama aksi berjalan.
Lambda (editor visual) atau Lambda (YAMLeditor)

Kecepatan start-up aksi yang dioptimalkan.

Untuk informasi selengkapnya tentang jenis komputasi, lihatJenis komputasi.

UI yang sesuai: Tab Konfigurasi/Tingkat Lanjut - opsional/Jenis komputasi

Fleet

(CDKBootstrapAction/Compute/Fleet)

(Opsional)

Tentukan mesin atau armada yang akan menjalankan alur kerja atau tindakan alur kerja Anda. Dengan armada sesuai permintaan, ketika suatu tindakan dimulai, alur kerja menyediakan sumber daya yang dibutuhkan, dan mesin dihancurkan ketika tindakan selesai. Contoh armada sesuai permintaan:Linux.x86-64.Large,. Linux.x86-64.XLarge Untuk informasi lebih lanjut tentang armada sesuai permintaan, lihat. Properti armada sesuai permintaan

Dengan armada yang disediakan, Anda mengonfigurasi satu set mesin khusus untuk menjalankan tindakan alur kerja Anda. Mesin-mesin ini tetap menganggur, siap untuk memproses tindakan segera. Untuk informasi selengkapnya tentang armada yang disediakan, lihat. Properti armada yang disediakan

Jika Fleet dihilangkan, defaultnya adalah. Linux.x86-64.Large

UI yang sesuai: Tab Konfigurasi/Advanced - armada opsional/Komputasi

Timeout

(CDKBootstrapAction/Timeout)

(Diperlukan)

Tentukan jumlah waktu dalam menit (YAMLeditor), atau jam dan menit (editor visual), bahwa tindakan dapat berjalan sebelum CodeCatalyst mengakhiri tindakan. Minimal adalah 5 menit dan maksimum dijelaskan dalamKuota untuk alur kerja di CodeCatalyst. Batas waktu default sama dengan batas waktu maksimum.

UI yang sesuai: Tab konfigurasi/Timeout - opsional

Inputs

(CDKBootstrapAction/Inputs)

(Opsional)

InputsBagian ini mendefinisikan data yang dibutuhkan tindakan AWS CDK bootstrap selama menjalankan alur kerja.

UI yang sesuai: Tab input

catatan

Hanya satu input (baik sumber atau artefak) yang diizinkan untuk setiap tindakan AWS CDK bootstrap.

Sources

(CDKBootstrapAction/Inputs/Sources)

(Diperlukan jika AWS CDK aplikasi Anda disimpan dalam repositori sumber)

Jika AWS CDK aplikasi Anda disimpan dalam repositori sumber, tentukan label repositori sumber tersebut. Tindakan AWS CDK bootstrap mensintesis aplikasi di repositori ini sebelum memulai proses bootstrap. Saat ini, satu-satunya label repositori yang didukung adalah. WorkflowSource

Jika AWS CDK aplikasi Anda tidak terkandung dalam repositori sumber, itu harus berada dalam artefak yang dihasilkan oleh tindakan lain.

Untuk informasi selengkapnya tentang sumber, lihat Menghubungkan repositori sumber ke alur kerja.

UI yang sesuai: Tab/Sumber Input - opsional

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

(Diperlukan jika AWS CDK aplikasi Anda disimpan dalam artefak keluaran dari tindakan sebelumnya)

Jika AWS CDK aplikasi Anda terkandung dalam artefak yang dihasilkan oleh tindakan sebelumnya, tentukan artefak tersebut di sini. Tindakan AWS CDK bootstrap mensintesis aplikasi dalam artefak yang ditentukan ke dalam CloudFormation template sebelum memulai proses bootstrap. Jika AWS CDK aplikasi Anda tidak terkandung dalam artefak, itu harus berada di repositori sumber Anda.

Untuk informasi selengkapnya tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.

UI yang sesuai: Tab masukan/Artefak - opsional

Outputs

(CDKBootstrapAction/Outputs)

(Opsional)

Mendefinisikan data yang dihasilkan oleh tindakan selama menjalankan alur kerja.

UI yang sesuai: Tab keluaran

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(Opsional)

Tentukan artefak yang dihasilkan oleh tindakan. Anda dapat mereferensikan artefak ini sebagai masukan dalam tindakan lain.

Untuk informasi selengkapnya tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.

UI yang sesuai: Tab keluaran/Artefak

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

(Diperlukan Artifacts - output jika disertakan)

Tentukan nama artefak yang akan berisi AWS CloudFormation template yang disintesis oleh aksi AWS CDK bootstrap saat runtime. Nilai default-nya adalah cdk_bootstrap_artifacts. Jika Anda tidak menentukan artefak, maka tindakan mensintesis template, tetapi tidak akan menyimpannya dalam artefak. Pertimbangkan untuk menyimpan template yang disintesis dalam artefak untuk menyimpan catatannya untuk tujuan pengujian atau pemecahan masalah.

UI yang sesuai: Tab Keluaran/Artefak/Tambahkan artefak/Bangun nama artefak

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

(Diperlukan Artifacts - output jika disertakan)

Tentukan file yang akan disertakan dalam artefak. Anda harus menentukan "cdk.out/**/*" untuk menyertakan AWS CloudFormation template yang disintesis AWS CDK aplikasi Anda.

catatan

cdk.outadalah direktori default tempat file yang disintesis disimpan. Jika Anda menentukan direktori keluaran selain cdk.out di cdk.json file Anda, tentukan direktori itu di sini, bukancdk.out.

UI yang sesuai: Tab Keluaran/Artefak/Tambahkan artefak/File yang dihasilkan oleh build

Environment

(CDKBootstrapAction/Environment)

(Diperlukan)

Tentukan CodeCatalyst lingkungan yang akan digunakan dengan tindakan. Tindakan terhubung ke Amazon Akun AWS dan opsional VPC yang ditentukan di lingkungan yang dipilih. Tindakan menggunakan IAM peran default yang ditentukan di lingkungan untuk terhubung ke Akun AWS, dan menggunakan IAM peran yang ditentukan dalam VPCkoneksi Amazon untuk terhubung ke AmazonVPC.

catatan

Jika IAM peran default tidak memiliki izin yang diperlukan oleh tindakan, Anda dapat mengonfigurasi tindakan untuk menggunakan peran yang berbeda. Untuk informasi selengkapnya, lihat Mengubah IAM peran suatu tindakan.

Untuk informasi lebih lanjut tentang lingkungan, lihat Menyebarkan ke Akun AWS dan VPCs danPembuatan lingkungan.

UI yang sesuai: Tab konfigurasi/Lingkungan

Name

(CDKBootstrapAction/Environment/Name)

(Diperlukan Environment jika disertakan)

Tentukan nama lingkungan yang ada yang ingin Anda kaitkan dengan tindakan.

UI yang sesuai: Tab konfigurasi/Lingkungan

Connections

(CDKBootstrapAction/Environment/Connections)

(Opsional dalam versi tindakan yang lebih baru; diperlukan dalam versi yang lebih lama)

Tentukan koneksi akun untuk dikaitkan dengan tindakan. Anda dapat menentukan maksimum satu koneksi akun di bawahEnvironment.

Jika Anda tidak menentukan koneksi akun:

Tindakan menggunakan Akun AWS koneksi dan IAM peran default yang ditentukan di lingkungan di CodeCatalyst konsol. Untuk informasi tentang menambahkan koneksi akun dan IAM peran default ke lingkungan, lihatPembuatan lingkungan.
IAMPeran default harus menyertakan kebijakan dan izin yang diperlukan oleh tindakan. Untuk menentukan kebijakan dan izin tersebut, lihat deskripsi properti Peran dalam dokumentasi YAML definisi tindakan.

Untuk informasi selengkapnya tentang koneksi akun, lihatMemungkinkan akses ke AWS sumber daya yang terhubung Akun AWS. Untuk informasi tentang menambahkan koneksi akun ke lingkungan, lihatPembuatan lingkungan.

UI yang sesuai: Salah satu dari berikut ini tergantung pada versi tindakan:

(Versi yang lebih baru) Tab konfigurasi/Lingkungan/Apa yang ada my-environment? /menu tiga titik/Beralih peran
(Versi lama) Tab konfigurasi/'lingkungan/akun/peran'/koneksi akun AWS

Name

(CDKBootstrapAction/Environment/Connections/Name)

(Diperlukan Connections jika disertakan)

Tentukan nama koneksi akun.

UI yang sesuai: Salah satu dari berikut ini tergantung pada versi tindakan:

(Versi yang lebih baru) Tab konfigurasi/Lingkungan/Apa yang ada my-environment? /menu tiga titik/Beralih peran
(Versi lama) Tab konfigurasi/'lingkungan/akun/peran'/koneksi akun AWS

Role

(CDKBootstrapAction/Environment/Connections/Role)

(Diperlukan Connections jika disertakan)

Tentukan nama IAM peran yang digunakan tindakan AWS CDK bootstrap untuk mengakses AWS dan menambahkan tumpukan bootstrap. Pastikan Anda telah menambahkan peran ke CodeCatalyst ruang Anda, dan peran tersebut mencakup kebijakan berikut.

Jika Anda tidak menentukan IAM peran, maka tindakan tersebut menggunakan IAM peran default yang tercantum di lingkungan di CodeCatalyst konsol. Jika Anda menggunakan peran default di lingkungan, pastikan itu memiliki kebijakan berikut.

catatan

Izin yang ditampilkan dalam kebijakan izin berikut adalah izin yang diperlukan oleh cdk bootstrap perintah untuk melakukan bootstrap pada saat penulisan. Izin ini dapat berubah jika AWS CDK perubahan perintah bootstrap nya.

Awas

Hanya gunakan peran ini dengan tindakan AWS CDK bootstrap. Ini sangat permisif, dan menggunakannya dengan tindakan lain dapat menimbulkan risiko keamanan.

Kebijakan izin berikut:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "ssm:GetParameterHistory",
                "ecr:PutImageScanningConfiguration",
                "cloudformation:*",
                "iam:CreateRole",
                "iam:AttachRolePolicy",
                "ssm:GetParameters",
                "iam:PutRolePolicy",
                "ssm:GetParameter",
                "ssm:DeleteParameters",
                "ecr:DeleteRepository",
                "ssm:PutParameter",
                "ssm:DeleteParameter",
                "iam:PassRole",
                "ecr:SetRepositoryPolicy",
                "ssm:GetParametersByPath",
                "ecr:DescribeRepositories",
                "ecr:GetLifecyclePolicy"
            ],
            "Resource": [
                "arn:aws:ssm:aws-region:aws-account:parameter/cdk-bootstrap/*",
                "arn:aws:cloudformation:aws-region:aws-account:stack/CDKToolkit/*",
                "arn:aws:ecr:aws-region:aws-account:repository/cdk-*",
                "arn:aws:iam::aws-account:role/cdk-*"
            ]
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "cloudformation:RegisterType",
                "cloudformation:CreateUploadBucket",
                "cloudformation:ListExports",
                "cloudformation:DescribeStackDriftDetectionStatus",
                "cloudformation:SetTypeDefaultVersion",
                "cloudformation:RegisterPublisher",
                "cloudformation:ActivateType",
                "cloudformation:ListTypes",
                "cloudformation:DeactivateType",
                "cloudformation:SetTypeConfiguration",
                "cloudformation:DeregisterType",
                "cloudformation:ListTypeRegistrations",
                "cloudformation:EstimateTemplateCost",
                "cloudformation:DescribeAccountLimits",
                "cloudformation:BatchDescribeTypeConfigurations",
                "cloudformation:CreateStackSet",
                "cloudformation:ListStacks",
                "cloudformation:DescribeType",
                "cloudformation:ListImports",
                "s3:*",
                "cloudformation:PublishType",
                "ecr:CreateRepository",
                "cloudformation:DescribePublisher",
                "cloudformation:DescribeTypeRegistration",
                "cloudformation:TestType",
                "cloudformation:ValidateTemplate",
                "cloudformation:ListTypeVersions"
            ],
            "Resource": "*"
        }
    ]
}

catatan

Pertama kali peran digunakan, gunakan wildcard berikut dalam pernyataan kebijakan sumber daya dan kemudian cakup kebijakan dengan nama sumber daya setelah tersedia.


"Resource": "*"

Kebijakan kepercayaan khusus berikut:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

catatan

Anda dapat menggunakan CodeCatalystWorkflowDevelopmentRole-spaceName peran dengan tindakan ini, jika Anda mau. Untuk informasi selengkapnya tentang peran ini, silakan lihat Membuat CodeCatalystWorkflowDevelopmentRole-spaceNameperan untuk akun dan ruang Anda. Memahami bahwa CodeCatalystWorkflowDevelopmentRole-spaceName peran tersebut memiliki izin akses penuh yang dapat menimbulkan risiko keamanan. Kami menyarankan Anda hanya menggunakan peran ini dalam tutorial dan skenario di mana keamanan kurang menjadi perhatian.

UI yang sesuai: Salah satu dari berikut ini tergantung pada versi tindakan:

(Versi yang lebih baru) Tab konfigurasi/Lingkungan/Apa yang ada my-environment? /menu tiga titik/Beralih peran
(Versi lama) Tab konfigurasi/'lingkungan/akun/peran'/ Peran

Configuration

(CDKBootstrapAction/Configuration)

(Diperlukan)

Bagian di mana Anda dapat menentukan properti konfigurasi tindakan.

UI yang sesuai: Tab konfigurasi

Region

(CDKBootstrapAction/Configuration/Region)

(Diperlukan)

Tentukan Wilayah AWS ke mana tumpukan bootstrap akan digunakan. Wilayah ini harus cocok dengan yang digunakan AWS CDK aplikasi Anda. Untuk daftar kode Wilayah, lihat Titik akhir Regional.

UI yang sesuai: Tab konfigurasi/Wilayah

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(Opsional)

Properti ini tersedia dengan versi 1.0.13 atau yang lebih baru dari tindakan AWS CDK penerapan, dan versi 1.0.8 atau yang lebih baru dari tindakan bootstrap.AWS CDK

Tentukan satu dari yang berikut ini:

Versi lengkap dari AWS Cloud Development Kit (AWS CDK) Command Line Interface (CLI) (juga disebut AWS CDK Toolkit) yang Anda ingin tindakan ini untuk digunakan. Contoh:2.102.1. Pertimbangkan untuk menentukan versi lengkap untuk memastikan konsistensi dan stabilitas saat membangun dan menerapkan aplikasi Anda.

Atau
latest. Pertimbangkan latest untuk menentukan untuk memanfaatkan fitur dan perbaikan terbaru dari. CDK CLI

Tindakan akan mengunduh versi yang ditentukan (atau versi terbaru) dari gambar CodeCatalyst build, dan kemudian menggunakan versi ini untuk menjalankan perintah yang diperlukan untuk menyebarkan CDK aplikasi Anda atau mem-bootstrap AWS lingkungan Anda. AWS CDK CLI

Untuk daftar CDK CLI versi yang didukung yang dapat Anda gunakan, lihat AWS CDK Versi.

Jika Anda menghilangkan properti ini, tindakan menggunakan AWS CDK CLI versi default yang dijelaskan dalam salah satu topik berikut:

UI yang sesuai: Tab/versi AWS CDK CLI konfigurasi

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

Variabel - tindakan 'AWS CDK bootstrap'

Penerbitan ke Amazon S3