HttpApiCorsConfiguration - AWS Serverless Application Model
構文プロパティ例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

HttpApiCorsConfiguration

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

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

注意: OpenAPI とプロパティレベルの両方で HTTPAPICorsConfiguration が設定されている場合、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