ApiUsagePlan

Configure un plan d'utilisation pour une API API Gateway. Pour plus d'informations sur les plans d'utilisation, consultez Création et utilisation de plans d'utilisation avec les clés API dans le Guide du développeur API Gateway.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

CreateUsagePlan

Détermine comment ce plan d'utilisation est configuré. Les valeurs valides sont PER_API, SHARED et NONE.

PER_API crée AWS::ApiGateway::UsagePlan,AWS::ApiGateway::ApiKey, et des ressources AWS::ApiGateway::UsagePlanKey propres à cette API. Ces ressources ont des ID logiques de <api-logical-id>UsagePlan,<api-logical-id>ApiKey, et <api-logical-id>UsagePlanKey, respectivement.

SHAREDles AWS::ApiGateway::UsagePlancréations et AWS::ApiGateway::ApiKeyles AWS::ApiGateway::UsagePlanKeyressources qui sont partagées entre toutes les API figurant également CreateUsagePlan: SHARED dans le même AWS SAM modèle. Ces ressources ont des ID logiques de ServerlessUsagePlan, ServerlessApiKey, et ServerlessUsagePlanKey, respectivement. Si vous utilisez cette option, nous vous recommandons d'ajouter une configuration supplémentaire pour ce plan d'utilisation sur une seule ressource API afin d'éviter des définitions conflictuelles et un état incertain.

NONE désactive la création ou l'association d'un plan d'utilisation avec cette API. Ceci n'est nécessaire que si SHARED ou PER_API est spécifié dans le paramètre Section Globals du modèle AWS SAM.

Valeurs valides: PER_API, SHARED, et NONE

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Description

Description du plan d'utilisation.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Description propriété d'une AWS::ApiGateway::UsagePlan ressource.

Quota

Configure le nombre de demandes que les utilisateurs peuvent soumettre au cours d'un intervalle donné.

Type : QuotaSettings

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Quota propriété d'une AWS::ApiGateway::UsagePlan ressource.

Tags

Tableau de balises arbitraires (paires clé-valeur) à associer au plan d'utilisation.

Cette propriété utilise le type de CloudFormation balise.

Type: liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Tags propriété d'une AWS::ApiGateway::UsagePlan ressource.

Throttle

Configure le taux de demandes global (nombre moyen de demandes par seconde), ainsi que la capacité de transmission en mode rafale.

Type : ThrottleSettings

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Throttle propriété d'une AWS::ApiGateway::UsagePlan ressource.

UsagePlanName

Nom pour le plan d'utilisation.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la UsagePlanName propriété d'une AWS::ApiGateway::UsagePlan ressource.

Exemples

UsagePlan

Voici un exemple de plan d'utilisation.

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