CorsConfiguration

Gestisci CORS (Cross-origin Resource Sharing) per le tue API Gateway API Gateway. Specificare il dominio da consentire come stringa o specificare un dizionario con configurazione Cor aggiuntiva. NOTA: Cor richiede che SAM modifichi la definizione OpenAPI, quindi funziona solo con OpenAPI inline definita nelDefinitionBodyproprietà.

Per ulteriori informazioni su CORS, consultaAbilitazione di CORS per una risorsa API REST di API GatewaynellaGuida per sviluppatori di API Gateway.

Nota: Se CorsConfiguration è impostato sia in OpenAPI che a livello di proprietà,AWS SAMli fonde, con le proprietà che hanno la precedenza.

Sintassi

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

YAML

  AllowCredentials: Boolean
  AllowHeaders: String
  AllowMethods: String
  AllowOrigin: String
  MaxAge: String

Proprietà

AllowCredentials

Booleano che indica se la richiesta è autorizzata a contenere le credenziali.

Type: Booleano

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone diAWS CloudFormationequivalente.

AllowHeaders

Stringa di intestazioni da consentire.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone diAWS CloudFormationequivalente.

AllowMethods

Stringa contenente i metodi HTTP da consentire.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone diAWS CloudFormationequivalente.

AllowOrigin

Stringa di origine da consentire.

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone diAWS CloudFormationequivalente.

MaxAge

Stringa contenente il numero di secondi per memorizzare nella cache la richiesta di verifica preliminare CORS.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone diAWS CloudFormationequivalente.

Esempi

CorsConfiguration

Esempio di configurazione Cors. Questa è solo una parte di unAWS SAMfile modello che mostra unAWS::Serverless::Apidefinizione con Cor configurato.

YAML

Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Cors:
        AllowMethods: "'POST, GET'"
        AllowHeaders: "'X-Forwarded-For'"
        AllowOrigin: "'www.example.com'"
        MaxAge: "'600'"
        AllowCredentials: true