DomainConfiguration

AWS::ApiGateway::DomainNameAccessAssociation リソースの生成に必要な設定。

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

タイプ: DomainAccessAssociation

必須: いいえ

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

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

タイプ: リスト

必須: いいえ

デフォルト: /

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

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

タイプ: 文字列

必須: はい

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

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

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

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

タイプ: 文字列

必須: はい

CloudFormation との互換性: このプロパティは、AWS::ApiGateway::DomainName リソースの DomainName プロパティに直接渡され、EndpointConfiguration が PRIVATE に設定されるときは AWS::ApiGateway::DomainNameV2 に直接渡されます。

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

有効な値: EDGE、REGIONAL、または PRIVATE

タイプ: 文字列

必須: いいえ

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

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

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

タイプ: MutualTlsAuthentication

必須: いいえ

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

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

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

タイプ: ブール

必須: いいえ

デフォルト: True

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

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

タイプ: 文字列

必須: いいえ

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

API Gateway ドメイン名にアタッチする IAM ポリシー。EndpointConfiguration を PRIVATE に設定した場合にのみ該当します。

Type: Json

必須: いいえ

CloudFormation との互換性: このプロパティは、EndpointConfiguration が PRIVATE に設定されるときに AWS::ApiGateway::DomainNameV2 リソースの Policy プロパティに直接渡されます。有効なポリシードキュメントの例については、「AWS::ApiGateway::DomainNameV2」を参照してください。

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

タイプ: Route53Configuration

必須: いいえ

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

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

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::ApiGateway::DomainName リソースの SecurityPolicy プロパティに直接渡され、EndpointConfiguration が PRIVATE に設定されるときは AWS::ApiGateway::DomainNameV2 に直接渡されます。PRIVATE エンドポイントでは、TLS_1_2 のみがサポートされています。