HttpApiCorsConfiguration

HTTP API에 대한 교차 오리진 리소스 공유(CORS)을 관리합니다. 허용할 도메인을 문자열로 지정하거나 추가 Cors 구성을 사용하여 사전을 지정합니다. 참고: Cors는 OpenAPI 정의를 수정하려면 SAM이 필요하므로 속성에 정의된 OpenApi 인라인에서만 작동합니다. DefinitionBody

HTTP API에 대한 자세한 내용을 알아보려면 API Gateway 개발자 안내서의 HTTP API를 참조하세요.

참고: HttpApiCorsConfiguration 가 OpenAPI와 속성 수준에서 모두 설정된 경우 우선 순위가 있는 속성과 AWS SAM 병합합니다.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서 이 엔티티를 선언하려면 다음 구문을 사용하십시오.

YAML

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

속성

AllowCredentials

보안 인증이 CORS 요청에 포함되는지 여부를 지정합니다.

유형: 부울

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

AllowHeaders

허용된 헤더의 모음을 나타냅니다.

유형: 목록

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

AllowMethods

허용된 HTTP 메서드의 모음을 나타냅니다.

유형: 목록

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

AllowOrigins

허용된 오리진의 모음을 나타냅니다.

유형: 목록

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

ExposeHeaders

노출된 헤더의 모음을 나타냅니다.

유형: 목록

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

MaxAge

브라우저가 사전 요청 결과를 캐시해야 하는 시간(초)을 지정합니다.

유형: 정수

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

예

HttpApiCorsConfiguration

HTTP API Cors 구성 예제.

YAML

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