HttpApiDomainConfiguration

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

タイプ: リスト

必須: いいえ

デフォルト: /

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

このドメイン名のエンドポイントの 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 CloudFormation リソース AWS SAM。

型: 文字列

必須: はい

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プロパティに直接渡されます。