Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
ApiStateMachineAuth
Configura la autorización a nivel de evento para una API, una ruta y un método específicos.
Sintaxis
Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.
YAML
ApiKeyRequired:BooleanAuthorizationScopes:ListAuthorizer:StringResourcePolicy:ResourcePolicyStatement
Propiedades
-
ApiKeyRequired -
Requiere una clave de API para esta API, ruta y método.
Tipo: Booleano
Obligatorio: no
CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.
-
Los ámbitos de autorización que se aplicarán a esta API, ruta y método.
Los ámbitos que especifica anularán los ámbitos aplicados por la propiedad de
DefaultAuthorizersi los ha especificado.Tipo: lista
Obligatorio: no
CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.
-
El
Authorizerpara una máquina de estados específica.Si especificaste un autorizador global para la API y quieres que esta máquina de estados sea pública, anula el autorizador global configurando
AuthorizerenNONE.Tipo: cadena
Obligatorio: no
CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.
-
ResourcePolicy -
Configura la política de recursos para esta API y esta ruta.
Tipo: ResourcePolicyStatement
Obligatorio: no
CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.
Ejemplos
StateMachine-Autenticación
El siguiente ejemplo especifica la autorización a nivel de máquina de estado.
YAML
Auth: ApiKeyRequired: true Authorizer: NONE
