ApiUsagePlan - AWS Serverless Application Model
SintaxePropriedadesExemplos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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 esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

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.

SHARED cria recursosAWS::ApiGateway::UsagePlan, AWS::ApiGateway::ApiKey e AWS::ApiGateway::UsagePlanKey que são compartilhados em qualquer API que também tenha CreateUsagePlan: SHARED no mesmo modelo AWS SAM. 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

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Description

Uma descrição do plano de uso.

Tipo: string

Obrigatório: não

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

Quota

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

Type: QuotaSettings

Obrigatório: não

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

Tags

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

Essa propriedade usa o tipo de tag CloudFormation.

Tipo: lista

Obrigatório: não

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

Throttle

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

Type: ThrottleSettings

Obrigatório: não

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

UsagePlanName

Um nome para o plano de uso.

Tipo: string

Obrigatório: não

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

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