ApiUsagePlan

Configura um plano de uso para uma API do API Gateway. Para obter mais informações sobre planos de uso, consulte Criar e usar planos de uso com chaves de API no Guia do desenvolvedor do Gateway da API.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

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

Propriedades

CreateUsagePlan

Determina como esse plano de uso é configurado. Os valores válidos são PER_API, SHARED e NONE.

PER_API cria recursos AWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey e AWS::ApiGateway::UsagePlanKey que são específicos para essa API. Esses recursos têm IDs lógicos de <api-logical-id>UsagePlan, <api-logical-id>ApiKey e <api-logical-id>UsagePlanKey, respectivamente.

SHAREDcria AWS::ApiGateway::UsagePlanAWS::ApiGateway::ApiKey, e AWS::ApiGateway::UsagePlanKeyrecursos que são compartilhados em qualquer API que também tenha CreateUsagePlan: SHARED o mesmo AWS SAM modelo. Esses recursos têm IDs lógicos de ServerlessUsagePlan, ServerlessApiKey e ServerlessUsagePlanKey, respectivamente. Se você usar essa opção, recomendamos adicionar configurações adicionais para esse plano de uso em apenas um recurso de API para evitar definições conflitantes e um estado incerto.

NONE desativa a criação ou associação de um plano de uso com essa API. Isso só é necessário se SHARED ou PER_API estiver especificado no Seção Global do modelo AWS SAM.

Valores válidos: PER_API, SHARED e NONE

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Description

Uma descrição do plano de uso.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Description propriedade de um AWS::ApiGateway::UsagePlan recurso.

Quota

Configura o número de solicitações que os usuários podem fazer em um determinado intervalo.

Tipo: QuotaSettings

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Quota propriedade de um AWS::ApiGateway::UsagePlan recurso.

Tags

Uma matriz de tags arbitrárias (pares de chave-valor) a ser associada ao plano de uso.

Essa propriedade usa o Tipo de CloudFormation Tag.

Tipo: lista

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Tags propriedade de um AWS::ApiGateway::UsagePlan recurso.

Throttle

Configura a taxa de solicitações geral (média de solicitações por segundo) e capacidade de intermitência.

Tipo: ThrottleSettings

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Throttle propriedade de um AWS::ApiGateway::UsagePlan recurso.

UsagePlanName

Um nome para o plano de uso.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a UsagePlanName propriedade de um AWS::ApiGateway::UsagePlan recurso.

Exemplos

UsagePlan

Veja a seguir um exemplo de plano 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