HttpApiCorsConfiguration - AWS Serverless Application Model
SintaxePropriedadesExemplos

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

HttpApiCorsConfiguration

Gerencie compartilhamento de recursos de origem cruzada (CORS, para suas APIs HTTP. Especifique o domínio a ser permitido como uma string ou especifique um dicionário com configuração de Cors adicional. OBSERVAÇÃO: O Cors exige que o SAM modifique sua definição de OpenAPI, portanto, ele só funciona com a OpenAPI embutida definida na propriedade DefinitionBody.

Para obter mais informações sobre o CORS, consulte Configurando o CORS para uma API HTTP no Guia do desenvolvedor do API Gateway.

Observação: se HttpApiCorsConfiguration estiver definido tanto na OpenAPI quanto no nível da propriedade, o AWS SAM mescla-os com as propriedades que têm precedência.

Sintaxe

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

YAML

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

Propriedades

AllowCredentials

Especifica se as credenciais estão incluídas na solicitação de CORS.

Tipo: booliano

Obrigatório: não

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

AllowHeaders

Representa uma coleção de cabeçalhos permitidos.

Tipo: lista

Obrigatório: não

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

AllowMethods

Representa uma coleção de métodos HTTP permitidos.

Tipo: lista

Obrigatório: não

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

AllowOrigins

Representa uma coleção de origens permitidas.

Tipo: lista

Obrigatório: não

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

ExposeHeaders

Representa uma coleção de cabeçalhos expostos.

Tipo: lista

Obrigatório: não

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

MaxAge

Especifica o número de segundos que o navegador deve armazenar em cache os resultados da solicitação de simulação.

Tipo: inteiro

Obrigatório: não

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

Exemplos

HttpApiCorsConfiguration

Exemplo de configuração do Cors da API HTTP.

YAML

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