Objek permintaan sumber daya kustom

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

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

Properti permintaan developer templat

Pengembang template menggunakan CloudFormation sumber daya AWS::CloudFormation::CustomResource, untuk menentukan sumber daya kustom dalam template.

DiAWS::CloudFormation::CustomResource, semua properti ditentukan oleh penyedia sumber daya kustom. Hanya ada satu properti yang diperlukan: ServiceToken.

ServiceTimeout

Waktu maksimum, dalam hitungan detik, yang dapat berlalu sebelum waktu operasi sumber daya kustom habis.

Nilai harus berupa bilangan bulat dari 1 hingga 3600. Nilai default adalah 3600 detik (1 jam).

Wajib: Tidak

Tipe: String

ServiceToken

Token layanan, seperti topik Amazon SNS ARN atau fungsi Lambda ARN. Token layanan harus dari Wilayah yang sama dengan tumpukan.

Wajib: Ya

Tipe: String

Semua bidang lain di properti sumber daya bersifat opsional dan dikirim, kata demi kata, ke penyedia sumber daya kustom di bidang permintaan. ResourceProperties Penyedia menentukan nama maupun konten yang valid dari bidang ini.

Bidang permintaan penyedia sumber daya khusus

Bidang ini dikirim dalam permintaan JSON dari CloudFormation penyedia sumber daya khusus dalam topik SNS yang telah dikonfigurasi penyedia untuk tujuan ini.

RequestType

Jenis permintaan diatur oleh operasi CloudFormation tumpukan (create-stack, update-stack, atau delete-stack) yang diprakarsai oleh pengembang template untuk tumpukan yang berisi sumber daya kustom.

Harus salah satu dari: Create, Update, atau Delete. Untuk informasi selengkapnya, lihat Tipe permintaan sumber daya khusus.

Wajib: Ya

Tipe: String

ResponseURL

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

Wajib: Ya

Tipe: String

StackId

Nama Sumber Daya Amazon (ARN) yang mengidentifikasi tumpukan yang berisi sumber daya khusus.

Menggabungkan StackId dengan RequestId formulir nilai yang dapat Anda gunakan untuk mengidentifikasi permintaan secara unik pada sumber daya khusus tertentu.

Wajib: Ya

Tipe: String

RequestId

ID unik untuk permintaan tersebut.

Menggabungkan StackId dengan RequestId formulir nilai yang dapat Anda gunakan untuk mengidentifikasi permintaan secara unik pada sumber daya khusus tertentu.

Wajib: Ya

Tipe: String

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: _@-.

Wajib: Ya

Tipe: String

LogicalResourceId

Nama template yang dipilih pengembang (ID logis) dari sumber daya kustom dalam template. AWS CloudFormation Ini disediakan untuk memfasilitasi komunikasi antara penyedia sumber daya khusus dan pengembang template.

Wajib: Ya

Tipe: String

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.

Wajib: Selalu dikirim dengan Update dan Delete permintaan; tidak pernah dikirim denganCreate.

Tipe: String

ResourceProperties

Bidang ini berisi isi Properties objek yang dikirim oleh pengembang template. Isinya ditentukan oleh penyedia sumber daya khusus.

Wajib: Tidak

Jenis: objek JSON

OldResourceProperties

Digunakan hanya untuk Update permintaan. Berisi properti sumber daya yang dideklarasikan sebelum permintaan pembaruan.

Wajib: Ya

Jenis: objek JSON