AWS SDK Version 3 for .NET
API Reference

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 {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. 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 https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.APIGateway.Model.CreateDomainNameResponse

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class CreateDomainNameResponse : AmazonWebServiceResponse

The CreateDomainNameResponse type exposes the following members

Constructors

NameDescription
Public Method CreateDomainNameResponse()

Properties

NameTypeDescription
Public Property CertificateArn System.String

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.

Public Property CertificateName System.String

Gets and sets the property CertificateName.

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

Public Property CertificateUploadDate System.DateTime

Gets and sets the property CertificateUploadDate.

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property DistributionDomainName System.String

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.

Public Property DistributionHostedZoneId System.String

Gets and sets the property DistributionHostedZoneId.

The 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.

Public Property EndpointConfiguration Amazon.APIGateway.Model.EndpointConfiguration

Gets and sets the property EndpointConfiguration.

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Name System.String

Gets and sets the property Name.

The custom domain name as an API host name, for example, my-api.example.com.

Public Property RegionalCertificateArn System.String

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.

Public Property RegionalCertificateName System.String

Gets and sets the property RegionalCertificateName.

The name of the certificate that will be used for validating the regional domain name.

Public Property RegionalDomainName System.String

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.

Public Property RegionalHostedZoneId System.String

Gets and sets the property RegionalHostedZoneId.

The 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.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
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