HttpApiDomainConfiguration

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

構文

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

YAML

  BasePath: List
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  MutualTlsAuthentication: MutualTlsAuthentication
  OwnershipVerificationCertificateArn: String
  Route53: Route53Configuration
  SecurityPolicy: String

プロパティ

BasePath

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

タイプ: リスト

必須: いいえ

デフォルト: /

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

CertificateArn

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

タイプ: 文字列

必須: はい

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

DomainName

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

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

タイプ: 文字列

必須: はい

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

EndpointConfiguration

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

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

タイプ: 文字列

必須: いいえ

[Default] (デフォルト): REGIONAL

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

MutualTlsAuthentication

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

タイプ: MutualTlsAuthentication

必須: いいえ

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

OwnershipVerificationCertificateArn

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

タイプ: 文字列

必須: いいえ

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

Route53

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

タイプ: Route53Configuration

必須: いいえ

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

SecurityPolicy

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

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

タイプ: 文字列

必須: いいえ

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

例

DomainName

DomainName の例

YAML

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