ApiStateMachineAuth - AWS Serverless Application Model

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 suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

Properties

ApiKeyRequired

Requiere una clave de API para esta API, ruta y método.

Type: Booleano

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

AuthorizationScopes

Los ámbitos de autorización que se aplicarán a esta API, ruta y método.

Los ámbitos que especifique invalidarán los ámbitos aplicados por elDefaultAuthorizerpropiedad si la ha especificado.

Type: Lista

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Authorizer

LaAuthorizerpara una máquina de estado específico.

Si ha especificado un autorizador global para la API y desea hacer pública esta máquina de estado, anule el autorizador global configurandoAuthorizeraNONE.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

ResourcePolicy

Configure la política de recursos para esta API y la ruta de acceso.

Type: Declaración de política de recursos

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Ejemplos

StateMachine Auth

En el ejemplo siguiente se especifica la autorización a nivel de máquina de estado.

YAML

Auth: ApiKeyRequired: true Authorizer: NONE