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 y NONE.

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

SHAREDcreaAWS::ApiGateway::UsagePlan,AWS::ApiGateway::ApiKey, yAWS::ApiGateway::UsagePlanKeyrecursos que se comparten en cualquier API que también tengaCreateUsagePlan: SHAREDen 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.

NONEdeshabilita la creación o asociación de un plan de uso con esta API. Esto solo es necesario siSHAREDoPER_APIse especifica en elSección global de la plantilla AWS SAM.

Valores válidos: PER_API, SHARED y NONE

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 alDescriptionpropiedad de unAWS::ApiGateway::UsagePlanrecurso.

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 alQuotapropiedad de unAWS::ApiGateway::UsagePlanrecurso.

Tags

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 alTagspropiedad de unAWS::ApiGateway::UsagePlanrecurso.

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 alThrottlepropiedad de unAWS::ApiGateway::UsagePlanrecurso.

UsagePlanName

Nombre para el plan de uso.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alUsagePlanNamepropiedad de unAWS::ApiGateway::UsagePlanrecurso.

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