ApiStateMachineAuth

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

Sintassi

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

YAML

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

Proprietà

ApiKeyRequired

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

Tipo: Booleano

Required: No

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

AuthorizationScopes

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

Gli ambiti specificati sostituiranno tutti gli ambiti applicati dalla DefaultAuthorizer proprietà, se l'hai specificata.

Tipo: Elenco

Required: No

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

Authorizer

AuthorizerPer una macchina a stati specifica.

Se hai specificato un autorizzatore globale per l'API e desideri rendere pubblica questa macchina a stati, sostituisci l'autorizzatore globale impostando su. Authorizer NONE

▬Tipo: stringa

Required: No

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

ResourcePolicy

Configura la politica delle risorse per questa API e questo percorso.

Tipo: ResourcePolicyStatement

Required: No

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

Esempi

StateMachine-Autenticazione

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

YAML

Auth:
  ApiKeyRequired: true
  Authorizer: NONE