ApiStateMachineAuth - AWS Serverless Application Model

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

ApiStateMachineAuth

Configura a autorização no nível do evento, para uma API, um caminho e um método específicos.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

Propriedades

ApiKeyRequired

Requer uma chave de API para essa API, caminho e método.

Tipo: booliano

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

AuthorizationScopes

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

Os escopos que você especificar substituirão quaisquer escopos aplicados pela propriedade DefaultAuthorizer, caso você a tenha especificado.

Tipo: Lista

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Authorizer

O Authorizer para uma máquina de estado específica.

Se você especificou um autorizador global para a API e deseja tornar essa máquina de estado pública, substitua o autorizador global configurando Authorizer como NONE.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

ResourcePolicy

Configure a política de recursos para esse caminho em uma API.

Tipo: ResourcePolicyStatement

Obrigatório: Não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Exemplos

StateMachine-Auth

O exemplo a seguir especifica a autorização no nível da máquina de estado.

YAML

Auth: ApiKeyRequired: true Authorizer: NONE