HttpApiDomainConfiguration - AWS Serverless Application Model

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

HttpApiDomainConfiguration

API のカスタムドメインを設定します。

Syntax

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

Properties

BasePath

Amazon API Gateway ドメイン名で設定するベースパスのリスト。

タイプ: リスト

必須: いいえ

デフォルト: /

AWS CloudFormation の互換性: このプロパティは、と似ています。ApiMappingKeyのプロパティAWS::ApiGatewayV2::ApiMappingリソースの使用量を AWS SAM は、複数のAWS::ApiGatewayV2::ApiMappingリソースは、このプロパティで指定される値ごとに 1 つずつ。

CertificateArn

このドメイン名のエンドポイントの AWS が管理する証明書の Amazon リソースネーム (ARN)。AWS Certificate Manager は、サポートされている唯一のソースです。

タイプ: 文字列

必須: はい

AWS CloudFormation の互換性: このプロパティは、の「」に直接渡されます。CertificateArnのプロパティAWS::ApiGateway2::DomainName DomainNameConfigurationリソースの使用量を

DomainName

API Gateway API のカスタムドメイン名。大文字はサポートされていません。

AWS SAM はAWS::ApiGatewayV2::DomainNameリソースを、このプロパティが設定された場合に選択します。このシナリオについては、「」を参照してください。DomainName プロパティが指定されています。生成された AWS CloudFormation リソースの詳細については、AWS CloudFormation リソースを生成する

タイプ: 文字列

必須: はい

AWS CloudFormation の互換性: このプロパティは、の「」に直接渡されます。DomainNameのプロパティAWS::ApiGateway2::DomainNameリソースの使用量を

EndpointConfiguration

カスタムドメインにマッピングする API Gateway エンドポイントのタイプを定義します。このプロパティの値は、CertificateArnプロパティは AWS CloudFormation でマッピングされます。

HTTP API の唯一の有効な値はです。REGIONAL

タイプ: 文字列

必須: いいえ

デフォルト値:REGIONAL

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

MutualTlsAuthentication

カスタムドメイン名の相互トランスポート層セキュリティ (TLS) 認証設定。

タイプ: MutualTlsAuthentication

必須: いいえ

AWS CloudFormation の互換性: このプロパティは、の「」に直接渡されます。MutualTlsAuthenticationのプロパティAWS::ApiGatewayV2::DomainNameリソースの使用量を

Route53

Amazon Route 53 設定を定義します。

タイプ: Route53Configuration

必須: いいえ

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

SecurityPolicy

このドメイン名のセキュリティポリシーの TLS バージョン。

HTTP API の唯一の有効な値はです。TLS_1_2

タイプ: 文字列

必須: いいえ

AWS CloudFormation の互換性: このプロパティは、の「」に直接渡されます。SecurityPolicyのプロパティAWS::ApiGatewayV2::DomainName DomainNameConfigurationデータ型

Examples

DomainName

DomainName の例

YAML

Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: REGIONAL Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - /foo - /bar