DomainConfiguration

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

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

タイプ: DomainAccessAssociation

必須: いいえ

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

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

タイプ: リスト

必須: いいえ

デフォルト: /

AWS CloudFormation 互換性: このプロパティは、 AWS::ApiGateway::BasePathMapping resource. AWS SAM creates multiple AWS::ApiGateway::BasePathMapping resources, one per BasePath specified in this property BasePathの プロパティに似ています。

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

タイプ: 文字列

必須: はい

AWS 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 プロパティが指定されている」を参照してください。生成された AWS CloudFormation リソースの詳細については、「」を参照してください用に生成された AWS CloudFormation リソース AWS SAM。

タイプ: 文字列

必須: はい

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

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

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

タイプ: 文字列

必須: いいえ

デフォルト: REGIONAL

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

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

タイプ: MutualTlsAuthentication

必須: いいえ

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

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

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

型: ブール

必須: いいえ

デフォルト: True

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

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

タイプ: 文字列

必須: いいえ

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

API Gateway ドメイン名にアタッチする IAM ポリシー。EndpointConfiguration が に設定されている場合にのみ適用されますPRIVATE。

型: Json

必須: いいえ

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

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

タイプ: Route53Configuration

必須: いいえ

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

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

タイプ: 文字列

必須: いいえ

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