Objek tanggapan sumber daya khusus

Topik ini menjelaskan properti objek respons untuk sumber daya CloudFormation kustom.

Untuk pengenalan sumber daya khusus dan cara kerjanya, lihatSumber daya khusus.

Bidang respons penyedia sumber daya khusus

Berikut ini adalah properti yang disertakan penyedia sumber daya khusus saat mengirim file JSON ke URL yang telah ditandatangani. Untuk informasi selengkapnya tentang mengunggah objek menggunakan URL yang telah ditetapkan sebelumnya, lihat topik terkait di Panduan Pengguna Layanan Penyimpanan Sederhana Amazon.

catatan

Ukuran total badan respons tidak dapat melebihi 4096 byte.

Status

Nilai status yang dikirim oleh penyedia sumber daya kustom sebagai respons terhadap permintaan AWS CloudFormation yang dihasilkan.

Harus SUCCESS atau FAILED.

Wajib: Ya

Tipe: String

Reason

Menjelaskan alasan respons kegagalan.

Diperlukan: Diperlukan jika Status adaFAILED. Sebaliknya, ini bersifat opsional.

Tipe: String

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.

Wajib: Ya

Tipe: String

StackId

Nama Sumber Daya Amazon (ARN) yang mengidentifikasi tumpukan yang berisi sumber daya khusus. Nilai respons ini harus disalin kata demi kata dari permintaan.

Wajib: Ya

Tipe: String

RequestId

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

Wajib: Ya

Tipe: String

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.

Wajib: Ya

Tipe: String

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 lebih lanjut tentang menggunakan NoEcho untuk menutupi informasi sensitif, lihat praktik terbaik Jangan sematkan kredensial dalam templat Anda.

Wajib: Tidak

Jenis: Boolean

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 akan terlihat melalui API yang memunculkan nilai properti (sepertiDescribeStackEvents).

Wajib: Tidak

Jenis: objek JSON