API Gateway Domain Name

API Gateway Domain Name in AWS represents a custom domain that you can map to your API Gateway APIs. It allows you to use your own domain names instead of the default execute-api endpoint, providing a more user-friendly and branded URL. You can configure base path mappings to route traffic to specific APIs and stages, and integrate with AWS Certificate Manager for SSL/TLS certificates to secure communication.

aws.apigateway_domain_name

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
certificate_arncorestringThe reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
certificate_namecorestringThe name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
certificate_upload_datecoretimestampThe timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
distribution_domain_namecorestringThe domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
distribution_hosted_zone_idcorestringThe region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
domain_namecorestringThe custom domain name as an API host name, for example, my-api.example.com.
domain_name_arncorestringThe ARN of the domain name.
domain_name_statuscorestringThe status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
domain_name_status_messagecorestringAn optional text message containing detailed information about status of the DomainName migration.
endpoint_configurationcorejsonThe endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
mutual_tls_authenticationcorejsonThe mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
ownership_verification_certificate_arncorestringThe ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
regional_certificate_arncorestringThe reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
regional_certificate_namecorestringThe name of the certificate that will be used for validating the regional domain name.
regional_domain_namecorestringThe domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
regional_hosted_zone_idcorestringThe region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
security_policycorestringThe Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
tagscorehstore