ApiStateMachineAuth

Configura l'autorizzazione a livello di evento, per un'API, un percorso e un metodo specifici.

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la sintassi seguente.

YAML

  ApiKeyRequired: Boolean
  AuthorizationScopes: List
  Authorizer: String
  ResourcePolicy: ResourcePolicyStatement

Proprietà

ApiKeyRequired

Richiede una chiave API per questa API, percorso e metodo.

Type: Booleano

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

AuthorizationScopes

Gli ambiti di autorizzazione da applicare a questa API, percorso e metodo.

Gli ambiti specificati sostituiranno gli ambiti applicati dalDefaultAuthorizerproprietà se l'hai specificata.

Type: Elenco

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Authorizer

LaAuthorizerper una macchina a stati specifici.

Se è stato specificato un autorizzatore globale per l'API e si desidera rendere pubblica questa macchina a stato, sovrascrivere l'autore globale impostandoAuthorizeraNONE.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

ResourcePolicy

Configurare il criterio delle risorse per questa API e il percorso.

Type: Dichiarazione sulla politica delle risorse

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Esempi

Auth StateMachine

L'esempio seguente specifica l'autorizzazione a livello di macchina statale.

YAML

Auth:
  ApiKeyRequired: true
  Authorizer: NONE