AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This
default API host name is of the
format. With the default host name, you can access the API's root resource with the
When you set up a custom domain name of
apis.example.com for this API,
you can then access the same resource using the URL of the
myApi is the base path mapping (BasePathMapping) of your
API under the custom domain name.
public class DomainName
The DomainName type exposes the following members
Gets and sets the property CertificateArn.
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
Gets and sets the property CertificateName.
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
Gets and sets the property CertificateUploadDate.
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
Gets and sets the property DistributionDomainName.
The 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.
Gets and sets the property DistributionHostedZoneId.
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
The valid value is
Gets and sets the property EndpointConfiguration.
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
Gets and sets the property Name.
The custom domain name as an API host name, for example,
Gets and sets the property RegionalCertificateArn.
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
Gets and sets the property RegionalCertificateName.
The name of the certificate that will be used for validating the regional domain name.
Gets and sets the property RegionalDomainName.
The 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.
Gets and sets the property RegionalHostedZoneId.
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms