HttpApiAuth

Configura l'autorizzazione per controllare l'accesso alla tua API HTTP Amazon API Gateway.

Per ulteriori informazioni sulla configurazione dell'accesso alle API HTTP, consulta Controllare e gestire l'accesso a un'API HTTP in API Gateway nella API Gateway Developer Guide.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

  Authorizers: OAuth2Authorizer | LambdaAuthorizer
  DefaultAuthorizer: String
  EnableIamAuthorizer: Boolean

Proprietà

Authorizers

L'autorizzatore utilizzato per controllare l'accesso all'API API Gateway.

Tipo: OAuth2Auth2Authorizer | LambdaAuthorizer

Required: No

Default: nessuna

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un equivalente. AWS CloudFormation

Note aggiuntive: AWS SAM aggiunge gli autorizzatori alla definizione OpenAPI.

DefaultAuthorizer

Specificate l'autorizzatore predefinito da utilizzare per autorizzare le chiamate API alla vostra API API Gateway. È possibile specificare AWS_IAM come autorizzatore predefinito se EnableIamAuthorizer è impostato su. true Altrimenti, specifica un autorizzatore che hai definito in. Authorizers

Tipo: stringa

Required: No

Default: nessuna

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

EnableIamAuthorizer

Specificare se utilizzare l'autorizzazione IAM per il percorso dell'API.

Tipo: Booleano

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Esempi

Autorizzatore OAuth 2.0

Esempio di autorizzatore OAuth 2.0

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer

Autorizzatore IAM

Esempio di autorizzatore IAM

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM