HttpApiCorsConfiguration - AWS Serverless Application Model

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

HttpApiCorsConfiguration

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

CORS の詳細については、「」を参照してください。HTTP API の CORS の設定()API Gateway 開発者ガイド

注意: HTTPAPICorsConfiguration が OpenAPI とプロパティレベルの両方で設定されている場合、AWS SAM は優先されるプロパティとマージします。

Syntax

このエンティティを宣言するには、AWS Serverless Application Model AWS SAM テンプレートでは、次の構文を使用します。

YAML

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

Properties

AllowCredentials

CORS リクエストに認証情報を含めるかどうかを指定します。

タイプ: ブール値

必須: いいえ

AWS CloudFormation の互換性: このプロパティは AWS SAM に固有であり、に同等のものはありません。

AllowHeaders

許可されるヘッダーのコレクションを表します。

タイプ: リスト

必須: いいえ

AWS CloudFormation の互換性: このプロパティは AWS SAM に固有であり、に同等のものはありません。

AllowMethods

許可される HTTP メソッドのコレクションを表します。

タイプ: リスト

必須: いいえ

AWS CloudFormation の互換性: このプロパティは AWS SAM に固有であり、に同等のものはありません。

AllowOrigins

許可されたオリジンのコレクションを表します。

タイプ: リスト

必須: いいえ

AWS CloudFormation の互換性: このプロパティは AWS SAM に固有であり、に同等のものはありません。

ExposeHeaders

公開されたヘッダーのコレクションを表します。

タイプ: リスト

必須: いいえ

AWS CloudFormation の互換性: このプロパティは AWS SAM に固有であり、に同等のものはありません。

MaxAge

ブラウザがプリフライトリクエスト結果をキャッシュする秒数。

タイプ: 整数

必須: いいえ

AWS CloudFormation の互換性: このプロパティは AWS SAM に固有であり、に同等のものはありません。

Examples

HttpApiCorsConfiguration

HTTP API CORS 設定例

YAML

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