HttpApiCorsConfiguration

HTTP API のクロスオリジンリソース共有 (CORS) を管理します。許可するドメインを文字列として指定するか、追加の CORS 設定でディクショナリを指定します。注: Cors では OpenAPI 定義を変更するために SAM が必要であるため、 DefinitionBodyプロパティで OpenApi 定義されているインラインでのみ機能します。

CORS の詳細については、API Gateway デベロッパーガイドの「HTTP API の CORS の設定」を参照してください。

注: 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