HttpApiCorsConfiguration

Gère le partage des ressources cross-origin (CORS) pour toutes vos API HTTP. Spécifiez le domaine à autoriser en tant que chaîne ou spécifiez un dictionnaire avec une configuration Cors supplémentaire. REMARQUE : Cors a besoin de SAM pour modifier votre définition d'OpenAPI. Cela ne fonctionne donc qu'avec les éléments en OpenApi ligne définis dans la propriété. DefinitionBody

Pour plus d'informations sur CORS, consultez la Configuration CORS pour une API HTTP dans le Guide du développeur API Gateway.

Remarque : S'il HttpApiCorsConfiguration est défini à la fois dans OpenAPI et au niveau des propriétés, il les AWS SAM fusionne avec les propriétés prioritaires.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

  AllowCredentials: Boolean
  AllowHeaders: List
  AllowMethods: List
  AllowOrigins: List
  ExposeHeaders: List
  MaxAge: Integer

Propriétés

AllowCredentials

Spécifie si les informations d'identification sont incluses dans la demande CORS.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

AllowHeaders

Représente une collection d'en-têtes autorisés.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

AllowMethods

Représente une collection de méthodes HTTP autorisées.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

AllowOrigins

Représente une collection d'origines autorisées.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

ExposeHeaders

Représente une collection d'en-têtes exposés.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

MaxAge

Nombre de secondes pendant lesquelles le navigateur doit mettre en cache les résultats de la demande de contrôle en amont.

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

HttpApiCorsConfiguration

Exemple de configuration Cors API HTTP.

YAML

CorsConfiguration:
  AllowOrigins:
    - "https://example.com"
  AllowHeaders:
    - x-apigateway-header
  AllowMethods:
    - GET
  MaxAge: 600
  AllowCredentials: true