DeploymentPreference

Menentukan konfigurasi untuk mengaktifkan deployment Lambda bertahap. Untuk informasi selengkapnya tentang konfigurasi deployment Lambda secara bertahap, lihat Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM.

catatan

Anda harus menentukan AutoPublishAlias dalam Anda AWS::Serverless::Function untuk menggunakan DeploymentPreference objek, jika tidak kesalahan akan terjadi.

Sintaks

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

  Alarms: List
  Enabled: Boolean
  Hooks: Hooks
  PassthroughCondition: Boolean
  Role: String
  TriggerConfigurations: List
  Type: String

Properti

Alarms

Daftar CloudWatch alarm yang ingin Anda picu oleh kesalahan apa pun yang dimunculkan oleh penerapan.

Properti ini menerima fungsi intrinsik Fn::If. Lihat bagian Contoh di bagian bawah topik ini untuk contoh templat yang menggunakan Fn::If.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Enabled

Apakah preferensi deployment ini diaktifkan.

Tipe: Boolean

Wajib: Tidak

Default: BETUL

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Hooks

Validasi fungsi Lambda yang dijalankan sebelum dan sesudah pergeseran lalu lintas.

Tipe: Hook

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

PassthroughCondition

Jika Benar, dan jika preferensi penerapan ini diaktifkan, Kondisi fungsi akan diteruskan ke CodeDeploy sumber daya yang dihasilkan. Umumnya, Anda harus mengatur ini ke True. Jika tidak, CodeDeploy sumber daya akan dibuat bahkan jika Kondisi fungsi diselesaikan menjadi False.

Tipe: Boolean

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Role

Peran IAM ARN CodeDeploy yang akan digunakan untuk pergeseran lalu lintas. IAM role tidak akan dibuat jika ini disediakan.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

TriggerConfigurations

Daftar konfigurasi pemicu yang ingin Anda kaitkan dengan grup deployment. Digunakan untuk memberitahu topik SNS pada peristiwa siklus hidup.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke TriggerConfigurations properti AWS::CodeDeploy::DeploymentGroup sumber daya.

Type

Ada dua kategori tipe deployment pada saat ini: Linear dan Canary. Untuk informasi selengkapnya tentang tipe deployment yang tersedia, lihat Menerapkan aplikasi tanpa server secara bertahap dengan AWS SAM.

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Contoh

DeploymentPreference dengan kait sebelum dan sesudah lalu lintas.

Contoh preferensi deployment yang berisi kait pra dan pascalalulintas.

YAML

DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    - Ref: AliasErrorMetricGreaterThanZeroAlarm
    - Ref: LatestVersionErrorMetricGreaterThanZeroAlarm
  Hooks:
    PreTraffic:
      Ref: PreTrafficLambdaFunction
    PostTraffic:
      Ref: PostTrafficLambdaFunction

DeploymentPreference dengan Fn: :Jika fungsi intrinsik

Contoh preferensi deployment yang menggunakan Fn::If untuk mengonfigurasi alarm. Dalam contoh ini, Alarm1 akan dikonfigurasi jika MyCondition adalah true, dan Alarm2 dan Alarm5 akan dikonfigurasi jika MyCondition adalah false.

YAML

DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    Fn::If:
      - MyCondition
      - - Alarm1
      - - Alarm2
        - Alarm5