ApiUsagePlan - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

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 para una API de API Gateway. Para obtener más información sobre claves de API, consulta el tema Creación y utilización de planes de uso de claves API en la Guía para desarrolladores de API Gateway.

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

Propiedades

CreateUsagePlan

Determina cómo se configura este plan de uso. Los valores válidos son PER_API, SHARED y NONE.

PER_API crea los recursos AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey y AWS::ApiGateway::UsagePlanKey específicos de esta API. Estos recursos tienen identificadores lógicos <api-logical-id>UsagePlan, <api-logical-id>ApiKey, y <api-logical-id>UsagePlanKey, respectivamente.

SHARED crea los recursos AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey y AWS::ApiGateway::UsagePlanKey que se comparten en cualquier API que también tenga CreateUsagePlan: SHARED en la misma plantilla de AWS SAM. Estos recursos tienen identificadores lógicos ServerlessUsagePlan, ServerlessApiKey, y ServerlessUsagePlanKey, respectivamente. Si usas esta opción, te recomendamos que añada una configuración adicional para este plan de uso en un solo recurso de API para evitar definiciones conflictivas y un estado incierto.

NONE inhabilita la creación o la asociación de un plan de uso con esta API. Esto solo es necesario si SHARED o PER_API se especifica en Sección Globals de la plantilla de AWS SAM.

Valores válidos: PER_API, SHARED y NONE

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

Description

Es una descripción del plan de uso.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Description de un recurso AWS::ApiGateway::UsagePlan.

Quota

Configura el número de solicitudes que pueden realizar los usuarios dentro de un determinado intervalo.

Type: QuotaSettings

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Quota de un recurso AWS::ApiGateway::UsagePlan.

Tags

Una matriz de etiquetas arbitrarias (pares de clave-valor) que se asocian al plan de uso.

Esta propiedad usa el tipo de etiqueta CloudFormation.

Tipo: lista

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Tags de un recurso AWS::ApiGateway::UsagePlan.

Throttle

Configura la tasa de solicitudes general (promedio de solicitudes por segundo) y la capacidad de ráfaga.

Type: ThrottleSettings

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Throttle de un recurso AWS::ApiGateway::UsagePlan.

UsagePlanName

Nombre para el plan de uso.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad UsagePlanName de un recurso AWS::ApiGateway::UsagePlan.

Ejemplos

UsagePlan

El siguiente es 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