Sumber daya API Gateway yang dapat ditandai

Tag dapat disetel pada API HTTP atau sumber daya WebSocket API berikut di Amazon API Gateway V2 API:

• Api

• DomainName

• Stage

• VpcLink

Selain itu, tag dapat disetel pada resource REST API berikut di Amazon API Gateway V1 API:

• ApiKey

• ClientCertificate

• DomainName

• RestApi

• Stage

• UsagePlan

• VpcLink

Tag tidak dapat disetel langsung pada sumber daya lain. Namun, di Amazon API Gateway V1 API, sumber daya turunan mewarisi tag yang disetel pada sumber daya induk. Sebagai contoh:

• Jika tag disetel pada RestApi sumber daya, tag tersebut diwarisi oleh sumber daya turunan berikut RestApi untuk kontrol akses berbasis Atribut:

  • Authorizer

  • Deployment

  • Documentation

  • GatewayResponse

  • Integration

  • Method

  • Model

  • Resource

  • ResourcePolicy

  • Setting

  • Stage

• Jika tag disetel padaDomainName, tag tersebut diwarisi oleh BasePathMapping sumber daya apa pun di bawahnya.

• Jika tag disetel padaUsagePlan, tag tersebut diwarisi oleh UsagePlanKey sumber daya apa pun di bawahnya.

catatan

Warisan tag hanya berlaku untuk kontrol akses berbasis atribut. Misalnya, Anda tidak dapat menggunakan tag yang diwariskan untuk memantau biaya masuk AWS Cost Explorer. Untuk menggunakan tag untuk alokasi biaya, sebaiknya Anda membuat tag pada sumber daya anak, seperti Stage sumber daya.

API Gateway tidak menampilkan tag yang diwariskan saat Anda memanggil GetTagssumber daya.

Warisan tag di Amazon API Gateway V1

Sebelumnya hanya mungkin untuk mengatur tag pada tahapan. Sekarang Anda juga dapat mengaturnya pada sumber daya lain, a Stage dapat menerima tag dua cara:

• Tag dapat diatur langsung pada fileStage.

• Tahap dapat mewarisi tag dari RestApi induknya.

Jika sebuah stage menerima tag dua arah, tag yang disetel langsung di atas panggung akan diutamakan. Misalnya, sebuah stage mewarisi tag berikut dari REST API induknya:

{
	'foo': 'bar',
	'x':'y'
}

Misalkan juga memiliki tag berikut yang disetel secara langsung:

{
	'foo': 'bar2',
	'hello': 'world'
}

Efek bersihnya adalah untuk tahap memiliki tag berikut, dengan nilai-nilai berikut:

{
	'foo': 'bar2',
	'hello': 'world'
	'x':'y'
}

Pembatasan tag dan konvensi penggunaan

Pembatasan dan konvensi penggunaan berikut berlaku untuk penggunaan tag dengan sumber daya API Gateway:

• Setiap sumber daya dapat memiliki maksimum 50 tag.

• Untuk setiap sumber daya, setiap kunci tag harus unik, dan setiap kunci tag hanya dapat memiliki satu nilai.

• Panjang kunci tag maksimum adalah 128 karakter Unicode dalam UTF-8.

• Panjang nilai tag maksimum adalah 256 karakter Unicode dalam UTF-8.

• Karakter yang diizinkan untuk kunci dan nilai adalah huruf, angka, spasi yang dapat direpresentasikan dalam UTF-8, dan karakter berikut: .: + = @ _/- (tanda hubung). Sumber daya Amazon EC2 memungkinkan karakter apa pun.

• Kunci dan nilai tag peka huruf besar dan kecil. Sebagai praktik terbaik, putuskan strategi untuk memanfaatkan tag dan terapkan strategi tersebut secara konsisten di semua jenis sumber daya. Misalnya, putuskan apakah akan menggunakan Costcenter, costcenter, atau CostCenter dan menggunakan kesepakatan yang sama untuk semua tag. Hindari penggunaan tag yang serupa dengan perlakuan kasus yang tidak konsisten.

• aws:Awalan dilarang untuk tag; itu dicadangkan untuk AWS digunakan. Anda tidak dapat mengedit atau menghapus kunci atau nilai tanda dengan prefiks ini. Tanda dengan prefiks ini tidak dihitung, berlawanan dengan tanda milik Anda per batas sumber daya.