Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
ApiUsagePlan
Configura un plan de uso de una API Gateway API. Para obtener más información acerca de los planes de uso de, consulteCreación y utilización de planes de uso con claves de APIen laGuía para desarrolladores de API Gateway.
Sintaxis
Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.
YAML
CreateUsagePlan:
String
Description:String
Quota:QuotaSettings
Tags:List
Throttle:ThrottleSettings
UsagePlanName:String
Properties
-
CreateUsagePlan
-
Determina cómo se configura este plan de uso. Los valores válidos son
PER_API
,SHARED
yNONE
.PER_API
creaAWS::ApiGateway::UsagePlan,AWS::ApiGateway::ApiKey, yAWS::ApiGateway::UsagePlanKeyrecursos específicos de esta API. Estos recursos tienen identificadores lógicos de
,<api-logical-id>
UsagePlan
, y<api-logical-id>
ApiKey
, respectivamente.<api-logical-id>
UsagePlanKeySHARED
creaAWS::ApiGateway::UsagePlan,AWS::ApiGateway::ApiKey, yAWS::ApiGateway::UsagePlanKeyrecursos que se comparten en cualquier API que también tengaCreateUsagePlan: SHARED
en el mismoAWS SAMplantilla. Estos recursos tienen identificadores lógicos deServerlessUsagePlan
,ServerlessApiKey
, yServerlessUsagePlanKey
, respectivamente. Si utiliza esta opción, le recomendamos que agregue una configuración adicional para este plan de uso en un solo recurso de API para evitar definiciones conflictivas y un estado incierto.NONE
deshabilita la creación o asociación de un plan de uso con esta API. Esto solo es necesario siSHARED
oPER_API
se especifica en elSección global de la plantilla AWS SAM.Valores válidos:
PER_API
,SHARED
yNONE
Type: Cadena
Obligatorio: Sí
AWS CloudFormationcompatibilidad: Este establecimiento es específico deAWS SAMy no tieneAWS CloudFormationequivalente.
-
Description
-
Es una descripción del plan de uso.
Type: Cadena
Obligatorio: No
AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente al
Description
propiedad de unAWS::ApiGateway::UsagePlan
recurso. -
Quota
-
Configura el número de solicitudes que pueden realizar los usuarios dentro de un determinado intervalo.
Type: QuotaSettings
Obligatorio: No
AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente al
Quota
propiedad de unAWS::ApiGateway::UsagePlan
recurso. -
Una matriz de etiquetas arbitrarias (pares de clave-valor) que se asocian al plan de uso.
Esta propiedad utiliza elTipo de etiqueta CloudFormation.
Type: Lista
Obligatorio: No
AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente al
Tags
propiedad de unAWS::ApiGateway::UsagePlan
recurso. -
Throttle
-
Configura la tasa de solicitudes general (promedio de solicitudes por segundo) y la capacidad de ráfaga.
Type: ThrottleSettings
Obligatorio: No
AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente al
Throttle
propiedad de unAWS::ApiGateway::UsagePlan
recurso. -
UsagePlanName
-
Nombre para el plan de uso.
Type: Cadena
Obligatorio: No
AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente al
UsagePlanName
propiedad de unAWS::ApiGateway::UsagePlan
recurso.
Ejemplos
UsagePlan
A continuación se muestra un ejemplo de plan de uso.
YAML
Auth: UsagePlan: CreateUsagePlan: PER_API Description: Usage plan for this API Quota: Limit: 500 Period: MONTH Throttle: BurstLimit: 100 RateLimit: 50 Tags: - Key: TagName Value: TagValue