Recursos de API Gateway que se pueden etiquetar - Amazon API Gateway
Herencia de etiquetas en la API V1 de Amazon API GatewayRestricciones de etiquetas y convenciones de uso

Recursos de API Gateway que se pueden etiquetar

Las etiquetas se pueden configurar en los siguientes recursos de API HTTP o API de WebSocket en la API V2 de Amazon API Gateway:

  • Api

  • DomainName

  • Stage

  • VpcLink

Además, las etiquetas se pueden configurar en los siguientes recursos de API REST en la API V1 de Amazon API Gateway:

  • ApiKey

  • ClientCertificate

  • DomainName

  • RestApi

  • Stage

  • UsagePlan

  • VpcLink

Las etiquetas no se pueden establecer directamente en otros recursos. Sin embargo, en la API V1 de Amazon API Gateway, los recursos secundarios heredan las etiquetas que se usan en los recursos principales. Por ejemplo:

  • Si una etiqueta se establece en un recurso RestApi, se hereda en los siguientes recursos secundarios de esa RestApi para el control de acceso basado en atributos:

    • Authorizer

    • Deployment

    • Documentation

    • GatewayResponse

    • Integration

    • Method

    • Model

    • Resource

    • ResourcePolicy

    • Setting

    • Stage

  • Si una etiqueta se establece en DomainName, se hereda en cualquiera de los recursos BasePathMapping por debajo de ella.

  • Si una etiqueta se establece en UsagePlan, se hereda en cualquiera de los recursos UsagePlanKey por debajo de ella.

nota

La herencia de etiquetas solo es aplicable al control de acceso basado en atributos. Por ejemplo, no se pueden usar etiquetas heredadas para supervisar los costos enAWS Cost Explorer. Para usar etiquetas para la asignación de costos, le recomendamos que cree etiquetas en los recursos secundarios, como el recurso Stage.

API Gateway no devuelve etiquetas heredadas cuando se llama a GetTags para un recurso.

Herencia de etiquetas en la API V1 de Amazon API Gateway

Antes solo se podían establecer etiquetas en etapas. Ahora que también puede establecerlas en otros recursos, Stage puede recibir una etiqueta de dos formas:

  • La etiqueta se puede configurar directamente en Stage.

  • La etapa puede heredar la etiqueta de su principa RestApi.

Si una etapa recibe una etiqueta de ambas maneras, tiene prioridad la etiqueta que se había establecido directamente en la etapa. Por ejemplo, suponga que una etapa hereda las siguientes etiquetas de su API REST principal:

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

Suponga que también tiene las siguientes etiquetas establecidas en ella directamente:

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

El efecto neto sería que la etapa tuviera las etiquetas siguientes, con estos valores:

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

Restricciones de etiquetas y convenciones de uso

Las siguientes restricciones y convenciones de uso se aplican al uso de etiquetas con recursos de API Gateway:

  • Cada recurso puede tener un máximo de 50 etiquetas.

  • Para cada recurso, cada clave de etiqueta debe ser única y solo puede tener un valor.

  • La longitud máxima de la clave de etiqueta es de 128 caracteres Unicode en UTF-8.

  • La longitud máxima del valor de etiqueta es de 256 caracteres Unicode en UTF-8.

  • Los caracteres permitidos para claves y valores son letras, números y espacios representables en UTF-8, además de los siguientes caracteres: . : + = @ _ / - (guion). Los recursos de Amazon EC2 admiten cualquier carácter.

  • Las claves y los valores de las etiquetas distinguen entre mayúsculas y minúsculas. Como práctica recomendada, decida una estrategia de uso de mayúsculas y minúsculas en las etiquetas e implemente esa estrategia sistemáticamente en todos los tipos de recursos. Por ejemplo, decida si se va a utilizar Costcenter, costcenter o CostCenter y utilice la misma convención para todas las etiquetas. Procure no utilizar etiquetas similares con un tratamiento de mayúsculas y minúsculas incoherente.

  • El prefijo aws: está prohibido para las etiquetas; está reservado para su uso por parte de AWS. Las claves y valores de etiquetas que tienen este prefijo no se pueden editar. Las etiquetas que tengan este prefijo no cuentan para el límite de etiquetas por recurso.