DomainConfiguration

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

構文

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

YAML

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

プロパティ

BasePath

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

タイプ: リスト

必須: いいえ

デフォルト: /

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

NormalizeBasePath

BasePath プロパティで定義されたベースパスに英数字以外の文字を使用できるかどうかを示します。True に設定すると、英数字以外の文字がベースパスから削除されます。

NormalizeBasePath を BasePath プロパティと一緒に使用します。

タイプ: ブール

必須: いいえ

デフォルト: True

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

CertificateArn

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

タイプ: 文字列

必須: はい

AWS CloudFormation との互換性: このプロパティは、AWS::ApiGateway::DomainName リソースの CertificateArn プロパティに似ています。EndpointConfiguration が REGIONAL (デフォルト値) に設定されている場合、 は RegionalCertificateArnの にCertificateArnマッピングされますAWS::ApiGateway::DomainName。EndpointConfiguration が に設定されている場合EDGE、 は CertificateArnの にCertificateArnマッピングされますAWS::ApiGateway::DomainName。

その他の注意点: EDGE エンドポイントの場合は、証明書を us-east-1 AWS リージョンで作成する必要があります。

DomainName

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

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

タイプ: 文字列

必須: はい

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

EndpointConfiguration

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

有効な値: REGIONAL または EDGE

タイプ：文字列

必須: いいえ

デフォルト: REGIONAL

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

MutualTlsAuthentication

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

と入力します。 MutualTlsAuthentication

必須: いいえ

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

OwnershipVerificationCertificateArn

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

タイプ: 文字列

必須: いいえ

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

Route53

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

タイプ: Route53Configuration

必須: いいえ

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

SecurityPolicy

このドメイン名の TLS バージョンと暗号スイートです。

タイプ: 文字列

必須: いいえ

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

例

DomainName

DomainName 例

YAML

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