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

HttpApiFunctionAuth

Configura a autorização no nível do evento.

Configurar Auth para uma API + Path + Method específica

Sintaxe

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

YAML

  AuthorizationScopes: List
  Authorizer: String

Propriedades

AuthorizationScopes

Os escopos de autorização a serem aplicados a essa API, caminho e método.

Os escopos listados aqui substituirão quaisquer escopos aplicados pelo, DefaultAuthorizer se existirem.

Tipo: lista

Obrigatório: não

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

Authorizer

O Authorizer para uma função específica. Para usar a autorização do IAM, especifique AWS_IAM e especifique true for EnableIamAuthorizer na Globals seção do seu modelo.

Se você especificou um autorizador global na API e deseja tornar pública uma função específica, substitua configurando Authorizer como NONE.

Type: string

Obrigatório: não

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

Exemplos

Function-Auth

Especificando a autorização no nível da função

YAML

Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2

Autorização do IAM

Especifica a autorização do IAM no nível do evento. Para usar a AWS_IAM autorização no nível do evento, você também deve especificar true for EnableIamAuthorizer na Globals seção do seu modelo. Para obter mais informações, consulte Seção Global do modelo AWS SAM.

YAML

Globals:
  HttpApi:
    Auth:
      EnableIamAuthorizer: true

Resources:
  HttpApiFunctionWithIamAuth:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
          Properties:
            Path: /iam-auth
            Method: GET
            Auth:
              Authorizer: AWS_IAM
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200}
      Runtime: python3.9