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

tindakan 'AWS CDK menyebarkan' YAML

Berikut ini adalah YAML definisi tindakan AWS CDK penyebaran. Untuk mempelajari cara menggunakan tindakan ini, lihatMenerapkan 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.

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

# The action definition starts here.   
  CDKDeploy_nn: 
    Identifier: aws/cdk-deploy@v2
    DependsOn:
      - CDKBootstrap
    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_artifact
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      StackName: my-cdk-stack
      Region: us-west-2
      Tags: '{"key1": "value1", "key2": "value2"}'
      Context: '{"key1": "value1", "key2": "value2"}'
      CdkCliVersion: version
      CdkRootPath: directory-containing-cdk.json-file
      CfnOutputVariables: '["CnfOutputKey1","CfnOutputKey2","CfnOutputKey3"]'
      CloudAssemblyRootPath: path-to-cdk.out

CDKDeploy

(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: CDKDeploy_nn.

UI yang sesuai: Tab konfigurasi/Nama tindakan

Identifier

(CDKDeploy/Identifier)

(Diperlukan)

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

Default: aws/cdk-deploy@v2.

UI yang sesuai: Diagram alur CDKDeploy kerja/_nn/ aws/cdk-deploy @v2 label

DependsOn

(CDKDeploy/DependsOn)

(Opsional)

Tentukan grup tindakan atau tindakan yang harus berjalan dengan sukses agar tindakan AWS CDK penerapan berjalan. Kami merekomendasikan untuk menentukan tindakan AWS CDK bootstrap di DependsOn properti, seperti ini:

CDKDeploy:
  Identifier: aws/cdk-deploy@v2
  DependsOn:
    - CDKBootstrap

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

UI yang sesuai: Tab masukan/Tergantung pada - opsional

Compute

(CDKDeploy/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

(CDKDeploy/Compute/Type)

(Diperlukan Compute jika disertakan)

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

Untuk informasi selengkapnya tentang jenis komputasi, lihatJenis komputasi.

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

Fleet

(CDKDeploy/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 lebih lanjut 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

(CDKDeploy/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

(CDKDeploy/Inputs)

(Opsional)

InputsBagian ini mendefinisikan data yang CDKDeploy dibutuhkan selama menjalankan alur kerja.

UI yang sesuai: Tab input

Sources

(CDKDeploy/Inputs/Sources)

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

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

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

(CDKDeploy/Inputs/Artifacts)

(Diperlukan jika AWS CDK aplikasi yang ingin Anda terapkan 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 penerapan mensintesis aplikasi dalam artefak yang ditentukan ke dalam CloudFormation templat sebelum memulai proses penerapan. 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: Input tab/Artefak - opsional

Outputs

(CDKDeploy/Outputs)

(Opsional)

Mendefinisikan data yang dihasilkan oleh tindakan selama menjalankan alur kerja.

UI yang sesuai: Tab keluaran

Artifacts - output

(CDKDeploy/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

(CDKDeploy/Outputs/Artifacts/Name)

(Diperlukan Artifacts - output jika disertakan)

Tentukan nama artefak yang akan berisi AWS CloudFormation template yang disintesis oleh tindakan AWS CDK penerapan saat runtime. Nilai default-nya adalah cdk_artifact. 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

(CDKDeploy/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.

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

Environment

(CDKDeploy/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.

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

UI yang sesuai: Tab konfigurasi/Lingkungan

Name

(CDKDeploy/Environment/Name)

(Diperlukan Environment jika disertakan)

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

UI yang sesuai: Tab konfigurasi/Lingkungan

Connections

(CDKDeploy/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:

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:

Name

(CDKDeploy/Environment/Connections/Name)

(Diperlukan Connections jika disertakan)

Tentukan nama koneksi akun.

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

Role

(CDKDeploy/Environment/Connections/Role)

(Diperlukan Connections jika disertakan)

Tentukan nama koneksi akun.

Tentukan nama IAM peran yang AWS CDK digunakan tindakan penerapan untuk mengakses AWS dan menyebarkan tumpukan AWS CDK aplikasi. 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.

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

Configuration

(CDKDeploy/Configuration)

(Diperlukan)

Bagian di mana Anda dapat menentukan properti konfigurasi tindakan.

UI yang sesuai: Tab konfigurasi

StackName

(CDKDeploy/Configuration/StackName)

(Diperlukan)

Nama tumpukan AWS CDK aplikasi Anda, seperti yang muncul di file entrypoint di direktori AWS CDK aplikasi Anda. bin Contoh berikut menunjukkan isi dari file TypeScript entrypoint, dengan nama stack disorot red italics. Jika file entrypoint Anda dalam bahasa yang berbeda, itu akan terlihat serupa.

import * as cdk from 'aws-cdk-lib';
import { CdkWorksopTypescriptStack } from '../lib/cdk_workshop_typescript-stack';

const app = new cdk.App();
new CdkWorkshopTypescriptStack(app, 'CdkWorkshopTypescriptStack');

Anda hanya dapat menentukan satu tumpukan.

UI yang sesuai: Tab konfigurasi/Nama tumpukan

Region

(CDKDeploy/Configuration/Region)

(Opsional)

Tentukan Wilayah AWS ke mana tumpukan AWS CDK aplikasi akan digunakan. Untuk daftar kode Wilayah, lihat Titik akhir Regional.

Jika Anda tidak menentukan Wilayah, tindakan AWS CDK penerapan akan diterapkan ke Wilayah yang ditentukan dalam kode Anda AWS CDK . Untuk informasi selengkapnya, lihat Lingkungan di Panduan AWS Cloud Development Kit (AWS CDK) Pengembang.

UI yang sesuai: Tab konfigurasi/Wilayah

Tags

(CDKDeploy/Configuration/Tags)

(Opsional)

Tentukan tag yang ingin Anda terapkan ke AWS sumber daya di tumpukan AWS CDK aplikasi. Tag diterapkan ke tumpukan itu sendiri serta sumber daya individu di tumpukan. Untuk informasi selengkapnya tentang penandaan, lihat Menandai di Panduan AWS Cloud Development Kit (AWS CDK) Pengembang.

UI yang sesuai: Tab Konfigurasi/Lanjutan - opsional/Tag

Context

(CDKDeploy/Configuration/Context)

(Opsional)

Tentukan konteks, dalam bentuk pasangan kunci-nilai, untuk dikaitkan dengan tumpukan aplikasi. AWS CDK Untuk informasi selengkapnya tentang konteks, lihat konteks Runtime di Panduan Pengembang.AWS Cloud Development Kit (AWS CDK)

UI yang sesuai: Tab Konfigurasi/Lanjutan - opsional/Konteks

CdkCliVersion

(CDKDeploy/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:

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

CdkRootPath

(CDKDeploy/Configuration/CdkRootPath)

(Opsional)

Path ke direktori yang berisi cdk.json file AWS CDK proyek Anda. Tindakan AWS CDK penyebaran berjalan dari folder ini, dan output apa pun yang dibuat oleh tindakan akan ditambahkan ke direktori ini. Jika tidak ditentukan, tindakan AWS CDK penerapan mengasumsikan bahwa cdk.json file tersebut ada di root proyek Anda. AWS CDK

UI yang sesuai: Tab konfigurasi/Direktori tempat cdk.json berada

CfnOutputVariables

(CDKDeploy/Configuration/CfnOutputVariables)

(Opsional)

Tentukan CfnOutput konstruksi mana dalam kode AWS CDK aplikasi yang ingin Anda paparkan sebagai variabel keluaran alur kerja. Anda kemudian dapat mereferensikan variabel keluaran alur kerja dalam tindakan selanjutnya dalam alur kerja Anda. Untuk informasi lebih lanjut tentang variabel di CodeCatalyst, lihatMenggunakan variabel dalam alur kerja.

Misalnya, jika kode AWS CDK aplikasi Anda terlihat seperti ini:

import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
import * as cdk from 'aws-cdk-lib';
export class HelloCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
      removalPolicy: RemovalPolicy.DESTROY,
    });
    new CfnOutput(this, 'bucketName', {
      value: bucket.bucketName,
      description: 'The name of the s3 bucket',
      exportName: 'amzn-s3-demo-bucket',
    });
    const table = new dynamodb.Table(this, 'todos-table', {
      partitionKey: {name: 'todoId', type: dynamodb.AttributeType.NUMBER},
      billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.DESTROY,
    })
    new CfnOutput(this, 'tableName', {
      value: table.tableName,
      description: 'The name of the dynamodb table',
      exportName: 'myDynamoDbTable',
    });
    ...
  }
}

... dan CfnOutputVariables properti Anda terlihat seperti ini:

Configuration:
  ...
  CfnOutputVariables: '["bucketName","tableName"]'

... maka tindakan menghasilkan variabel output alur kerja berikut:

Anda kemudian dapat mereferensikan tableName variabel bucketName dan dalam tindakan selanjutnya. Untuk mempelajari cara mereferensikan variabel keluaran alur kerja dalam tindakan selanjutnya, lihatMerujuk variabel yang telah ditentukan.

Jika Anda tidak menentukan CfnOutput konstruksi apa pun di CfnOutputVariables properti, maka tindakan tersebut mengekspos empat (atau lebih sedikit) variabel CloudFormation keluaran pertama yang ditemukannya sebagai variabel keluaran alur kerja. Untuk informasi selengkapnya, lihat variabel 'AWS CDK penyebaran'.

Untuk informasi lebih lanjut tentang variabel AWS CloudFormation output, lihat dokumentasi untuk CfnOutput konstruksi, tersedia di kelas CfnOutput (konstruksi) di Referensi AWS Cloud Development Kit (AWS CDK) API.

UI yang sesuai: Variabel AWS CloudFormation tab/output konfigurasi

CloudAssemblyRootPath

(CDKDeploy/Configuration/CloudAssemblyRootPath)

(Opsional)

Jika Anda telah mensintesis tumpukan AWS CDK aplikasi ke dalam rakitan cloud (menggunakan cdk synth operasi), tentukan jalur root direktori perakitan cloud (cdk.out). AWS CloudFormation Template yang terletak di direktori perakitan cloud yang ditentukan akan digunakan oleh tindakan AWS CDK penerapan ke dalam Anda Akun AWS menggunakan perintah. cdk deploy --app Ketika --app opsi hadir, cdk synth operasi tidak terjadi.

Jika Anda tidak menentukan direktori perakitan cloud, maka tindakan AWS CDK penerapan akan menjalankan cdk deploy perintah tanpa --app opsi. Tanpa --app opsi, cdk deploy operasi akan mensintesis (cdk synth) dan menerapkan aplikasi Anda ke dalam AWS CDK aplikasi Anda. Akun AWS

Mengapa saya menentukan rakitan cloud yang sudah ada dan disintesis ketika tindakan "AWS CDK penerapan” dapat melakukan sintesis pada waktu berjalan?

Anda mungkin ingin menentukan rakitan cloud yang sudah ada dan disintesis ke:

Untuk informasi tentang mengonfigurasi cdk.json file agar menyertakan perintah untuk menginstal dan menjalankan AWS CDK aplikasi, lihat Menentukan perintah aplikasi.

Untuk informasi tentang cdk synth perintah cdk deploy dan, serta --app opsi, lihat Menerapkan tumpukan, Mensintesis tumpukan, dan Melewati sintesis di Panduan Pengembang.AWS Cloud Development Kit (AWS CDK)

Untuk informasi tentang rakitan cloud, lihat Cloud Assembly di Referensi.AWS Cloud Development Kit (AWS CDK) API

UI yang sesuai: Tab konfigurasi/Jalur ke direktori perakitan cloud