Perbarui - AWS CloudFormation
PermintaanRespons

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

Perbarui

Ketika pengembang template membuat perubahan pada properti sumber daya kustom dalam template dan memperbarui tumpukan, CloudFormation mengirimkan permintaan ke penyedia sumber daya kustom dengan RequestType set keUpdate. Ini berarti bahwa kode sumber daya kustom Anda tidak harus mendeteksi perubahan sumber daya karena mengetahui bahwa propertinya telah berubah ketika jenis permintaanUpdate.

Untuk pengenalan sumber daya khusus dan cara kerjanya, lihatBuat logika penyediaan khusus dengan sumber daya khusus.

Permintaan

Permintaan Perbarui berisi bidang berikut:

RequestType

Update.

RequestId

ID unik untuk permintaan tersebut.

ResponseURL

Respons URL mengidentifikasi bucket S3 yang telah ditetapkan sebelumnya yang menerima tanggapan dari penyedia sumber daya kustom ke. AWS CloudFormation

ResourceType

Jenis sumber daya yang dipilih pengembang template dari sumber daya kustom dalam template. CloudFormation Nama jenis sumber daya kustom dapat memiliki panjang hingga 60 karakter dan dapat mencakup alfanumerik dan karakter berikut: _@-. Anda tidak dapat mengubah jenis selama pembaruan.

LogicalResourceId

Nama template yang dipilih pengembang (ID logis) dari sumber daya kustom dalam template. AWS CloudFormation

StackId

Amazon Resource Name (ARN) yang mengidentifikasi tumpukan yang berisi sumber daya kustom.

PhysicalResourceId

ID fisik yang ditentukan penyedia sumber daya kustom wajib yang unik untuk penyedia tersebut.

Nilai yang dikembalikan untuk PhysicalResourceId dapat mengubah operasi pembaruan sumber daya kustom. Jika nilai yang dikembalikan sama, itu dianggap sebagai pembaruan normal. Jika nilai yang dikembalikan berbeda, AWS CloudFormation mengenali pembaruan sebagai pengganti dan mengirimkan permintaan hapus ke sumber daya lama. Untuk informasi selengkapnya, lihat AWS::CloudFormation::CustomResource.

ResourceProperties

Nilai properti sumber daya baru yang dideklarasikan oleh pengembang template dalam CloudFormation template yang diperbarui.

OldResourceProperties

Nilai properti sumber daya yang sebelumnya dideklarasikan oleh pengembang template dalam CloudFormation template.

Contoh

{
   "RequestType" : "Update",
   "RequestId" : "unique id for this update request",
   "ResponseURL" : "pre-signed-url-for-update-response",
   "ResourceType" : "Custom::MyCustomResourceType",
   "LogicalResourceId" : "name of resource in template",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10",
   "PhysicalResourceId" : "custom resource provider-defined physical id",
   "ResourceProperties" : {
      "key1" : "new-string",
      "key2" : [ "new-list" ],
      "key3" : { "key4" : "new-map" }
   },
   "OldResourceProperties" : {
      "key1" : "string",
      "key2" : [ "list" ],
      "key3" : { "key4" : "map" }
   }
}

Respons

Berhasil

Jika penyedia sumber daya kustom berhasil memperbarui sumber daya, CloudFormation mengharapkan status disetel ke SUCCESS dalam respons.

Status

Harus berupa SUCCESS.

RequestId

ID unik untuk permintaan tersebut. Nilai respons ini harus disalin kata demi kata dari permintaan.

LogicalResourceId

Nama template yang dipilih pengembang (ID logis) dari sumber daya kustom dalam template. AWS CloudFormation Nilai respons ini harus disalin kata demi kata dari permintaan.

StackId

Amazon Resource Name (ARN) yang mengidentifikasi tumpukan yang berisi sumber daya kustom. Nilai respons ini harus disalin kata demi kata dari permintaan.

PhysicalResourceId

Nilai ini harus menjadi pengenal yang unik untuk vendor sumber daya khusus, dan dapat berukuran hingga 1 KB. Nilai harus berupa string yang tidak kosong dan harus identik untuk semua tanggapan untuk sumber daya yang sama.

Nilai yang dikembalikan untuk PhysicalResourceId dapat mengubah operasi pembaruan sumber daya kustom. Jika nilai yang dikembalikan sama, itu dianggap sebagai pembaruan normal. Jika nilai yang dikembalikan berbeda, AWS CloudFormation mengenali pembaruan sebagai pengganti dan mengirimkan permintaan hapus ke sumber daya lama. Untuk informasi selengkapnya, lihat AWS::CloudFormation::CustomResource.

NoEcho

Tidak wajib. Menunjukkan apakah akan menutupi output dari sumber daya kustom saat diambil dengan menggunakan Fn::GetAtt fungsi. Jika disetel ketrue, semua nilai yang dikembalikan ditutupi dengan tanda bintang (*****), kecuali yang disimpan di bagian Metadata template. AWS CloudFormation tidak mengubah, memodifikasi, atau menyunting informasi apa pun yang Anda sertakan di Metadata bagian ini. Nilai default-nya adalah false.

Untuk informasi selengkapnya tentang penggunaan NoEcho untuk menutupi informasi sensitif, lihat praktik Jangan menanamkan kredensial dalam templat Anda terbaik.

Data

Tidak wajib. Pasangan nama-nilai yang ditentukan penyedia sumber daya khusus untuk dikirim dengan respons. Anda dapat mengakses nilai yang disediakan di sini dengan nama di template denganFn::GetAtt.

penting

Jika pasangan nama-nilai berisi informasi sensitif, Anda harus menggunakan NoEcho bidang untuk menutupi output dari sumber daya kustom. Jika tidak, nilai terlihat melalui APIs nilai properti permukaan (sepertiDescribeStackEvents).

Contoh

{
   "Status" : "SUCCESS",
   "RequestId" : "unique id for this update request (copied from request)",
   "LogicalResourceId" : "name of resource in template (copied from request)",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10 (copied from request)",
   "PhysicalResourceId" : "custom resource provider-defined physical id",
   "Data" : {
      "keyThatCanBeUsedInGetAtt1" : "data for key 1",
      "keyThatCanBeUsedInGetAtt2" : "data for key 2"
   }
}

Failed

Jika sumber daya tidak dapat diperbarui dengan kumpulan properti baru, CloudFormation mengharapkan status disetelFAILED, bersama dengan alasan kegagalan dalam respons.

Status

Harus berupa FAILED.

Reason

Menjelaskan alasan respons kegagalan.

RequestId

ID unik untuk permintaan tersebut. Nilai respons ini harus disalin kata demi kata dari permintaan.

LogicalResourceId

Nama template yang dipilih pengembang (ID logis) dari sumber daya kustom dalam template. AWS CloudFormation Nilai respons ini harus disalin kata demi kata dari permintaan.

StackId

Amazon Resource Name (ARN) yang mengidentifikasi tumpukan yang berisi sumber daya kustom. Nilai respons ini harus disalin kata demi kata dari permintaan.

PhysicalResourceId

Nilai ini harus menjadi pengenal yang unik untuk vendor sumber daya khusus, dan dapat berukuran hingga 1 KB. Nilai harus berupa string yang tidak kosong dan harus identik untuk semua tanggapan untuk sumber daya yang sama.

Nilai yang dikembalikan untuk PhysicalResourceId dapat mengubah operasi pembaruan sumber daya kustom. Jika nilai yang dikembalikan sama, itu dianggap sebagai pembaruan normal. Jika nilai yang dikembalikan berbeda, AWS CloudFormation mengenali pembaruan sebagai pengganti dan mengirimkan permintaan hapus ke sumber daya lama. Untuk informasi selengkapnya, lihat AWS::CloudFormation::CustomResource.

Contoh

{
   "Status" : "FAILED",
   "Reason" : "Required failure reason string",
   "RequestId" : "unique id for this update request (copied from request)",
   "LogicalResourceId" : "name of resource in template (copied from request)",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10 (copied from request)",
   "PhysicalResourceId" : "custom resource provider-defined physical id"
}