ApiAuth - 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á.

ApiAuth

Configure a autorização para controlar o acesso à sua API API Gateway.

Para obter mais informações e exemplos para configurar o acesso usando, AWS SAM consulteControle o acesso à API com seu AWS SAM modelo.

Sintaxe

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

YAML

  AddApiKeyRequiredToCorsPreflight: Boolean
  AddDefaultAuthorizerToCorsPreflight: Boolean
  ApiKeyRequired: Boolean
  Authorizers: CognitoAuthorizer | LambdaTokenAuthorizer | LambdaRequestAuthorizer | AWS_IAM
  DefaultAuthorizer: String
  InvokeRole: String
  ResourcePolicy: ResourcePolicyStatement
  UsagePlan: ApiUsagePlan
nota

A Authorizers propriedade incluiAWS_IAM, mas não é necessária nenhuma configuração extraAWS_IAM. Para obter um exemplo, consulte AWS IAM.

Propriedades

AddApiKeyRequiredToCorsPreflight

Se as propriedades ApiKeyRequired e Cors estiverem definidas, a configuração AddApiKeyRequiredToCorsPreflight fará com que a chave de API seja adicionada à propriedade Options.

Tipo: booliano

Obrigatório: não

Padrão: True

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

AddDefaultAuthorizerToCorsPreflight

Se as propriedades DefaultAuthorizer e Cors estiverem definidas, a configuração AddDefaultAuthorizerToCorsPreflight fará com que o autorizador padrão seja adicionado à propriedade Options na seção OpenAPI.

Tipo: booliano

Obrigatório: não

Padrão: verdadeiro

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

ApiKeyRequired

Se definido como verdadeiro, uma chave de API é necessária para todos os eventos da API. Para obter mais informações sobre chaves de API, consulte Criar e usar planos de uso com chaves de API no Guia do desenvolvedor do Gateway da API.

Tipo: booliano

Obrigatório: não

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

Authorizers

O autorizador usado para controlar o acesso à sua API do API Gateway.

Para obter mais informações, consulte Controle o acesso à API com seu AWS SAM modelo.

Tipo: CognitoAuthorizer| LambdaTokenAuthorizer| LambdaRequestAuthorizer| AWS_IAM

Obrigatório: não

Padrão: nenhum

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

Notas adicionais: O SAM adiciona os Autorizadores à OpenApi definição de uma Api.

DefaultAuthorizer

Especifique um autorizador padrão para uma API do API Gateway, que será usada para autorizar chamadas de API por padrão.

nota

Se a API EventSource da função associada a essa API estiver configurada para usar permissões do IAM, essa propriedade deverá ser definida comoAWS_IAM, caso contrário, ocorrerá um erro.

Tipo: string

Obrigatório: não

Padrão: nenhum

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

InvokeRole

Define as credenciais de integração para todos os recursos e métodos com esse valor.

CALLER_CREDENTIALSmapeia para arn:aws:iam:::<user>/, que usa as credenciais do chamador para invocar o endpoint.

Valores válidos: CALLER_CREDENTIALS, NONE, IAMRoleArn

Tipo: string

Obrigatório: não

Padrão: CALLER_CREDENTIALS

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

ResourcePolicy

Configure a política de recursos para todos os métodos e caminhos em uma API.

Digite: ResourcePolicyStatement

Obrigatório: não

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

Notas adicionais: Essa configuração também pode ser definida individualmente AWS::Serverless::Function usando ApiFunctionAuth. Isso é necessário para APIs comEndpointConfiguration: PRIVATE.

UsagePlan

Configura um plano de uso associado a essa API. 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 API Gateway.

Essa AWS SAM propriedade gera três AWS CloudFormation recursos adicionais quando essa propriedade é definida: um AWS::ApiGateway::UsagePlan, um AWS::ApiGateway::UsagePlanKey, e um AWS::ApiGateway::ApiKey. Para obter informações sobre esse cenário, consulteUsagePlanpropriedade é especificada. Para obter informações gerais sobre AWS CloudFormation os recursos gerados, consulteAWS CloudFormation Recursos gerados para AWS SAM.

Digite: ApiUsagePlan

Obrigatório: não

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

Exemplos

CognitoAuth

Exemplo de Cognito Auth

YAML

Auth:
  Authorizers:
    MyCognitoAuth:
     UserPoolArn:
       Fn::GetAtt:
         - MyUserPool
         - Arn
     AuthType: "COGNITO_USER_POOLS"
  DefaultAuthorizer: MyCognitoAuth
  InvokeRole: CALLER_CREDENTIALS
  AddDefaultAuthorizerToCorsPreflight: false
  ApiKeyRequired: false
  ResourcePolicy:
    CustomStatements: [{
      "Effect": "Allow",
      "Principal": "*",
      "Action": "execute-api:Invoke",
      "Resource": "execute-api:/Prod/GET/pets",
      "Condition": {
          "IpAddress": {
              "aws:SourceIp": "1.2.3.4"
          }
        }
    }]
    IpRangeDenylist:
      - "10.20.30.40"

AWS IAM

AWS Exemplo de IAM

YAML

Auth:
  Authorizers: AWS_IAM