HttpApiDomainConfiguration

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

タイプ: リスト

必須: いいえ

デフォルト: /

AWS CloudFormation との互換性: このプロパティは AWS::ApiGatewayV2::ApiMapping リソースの ApiMappingKey プロパティと似ています。AWS SAM は複数の AWS::ApiGatewayV2::ApiMapping リソースを作成します (このプロパティに指定された値につき 1 つ)。

このドメイン名のエンドポイント用の AWS マネージド証明書の Amazon リソースネーム (ARN) です。サポートされるソースは AWS Certificate Manager のみです。

型: 文字列

必須: はい

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

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

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

型: 文字列

必須: はい

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

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

HTTP API に有効な値は REGIONAL のみです。

型: 文字列

必須: いいえ

デフォルト: REGIONAL

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

カスタムドメイン名の相互 Transport Layer Security (TLS) 認証設定です。

タイプ: MutualTlsAuthentication

必須: いいえ

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

カスタムドメインの所有権を検証するために ACM によって発行されたパブリック証明書の ARN。相互 TLS を設定し、ACM にインポートされた、またはプライベート CA 証明書の ARN を CertificateArn に指定する場合のみ必須です。

型: 文字列

必須: いいえ

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

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

タイプ: Route53Configuration

必須: いいえ

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

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

HTTP API に有効な値は TLS_1_2 のみです。

型: 文字列

必須: いいえ

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