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 tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

YAML

  CreateUsagePlan: String
  Description: String
  Quota: QuotaSettings
  Tags: List
  Throttle: ThrottleSettings
  UsagePlanName: String

Propiedades

CreateUsagePlan

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

PER_APIcrea AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey, y AWS::ApiGateway::UsagePlanKeyrecursos que son específicos de esta API. Estos recursos tienen una lógica IDs de <api-logical-id>UsagePlan<api-logical-id>ApiKey, y<api-logical-id>UsagePlanKey, respectivamente.

SHAREDcrea AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey, y AWS::ApiGateway::UsagePlanKeyrecursos que se comparten en cualquier API que también esté incluida CreateUsagePlan: SHARED en la misma AWS SAM plantilla. Estos recursos tienen una lógica IDs de ServerlessUsagePlanServerlessApiKey, yServerlessUsagePlanKey, 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í

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

Description

Es una descripción del plan de uso.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Description propiedad de un AWS::ApiGateway::UsagePlan recurso.

Quota

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

Tipo: QuotaSettings

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Quota propiedad de un AWS::ApiGateway::UsagePlan recurso.

Tags

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

Esta propiedad usa el tipo de CloudFormation etiqueta.

Tipo: lista

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Tags propiedad de un AWS::ApiGateway::UsagePlan recurso.

Throttle

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

Tipo: ThrottleSettings

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Throttle propiedad de un AWS::ApiGateway::UsagePlan recurso.

UsagePlanName

Nombre para el plan de uso.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la UsagePlanName propiedad de un AWS::ApiGateway::UsagePlan recurso.

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