Amazon API Gateway REST API Reference

DomainName

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
domainname:create

Creates a new domain name.

POST No
domainname:update

Changes information about the domain name resource.

PATCH No
domainname:delete

Deletes the domain name resource.

DELETE No
domainname:basepathmappings

Gets the BasePathMappings resource representing the collection of base path mappings for the specified custom domain name.

This link relation offers the following templated variable(s):

  • limit: Optional.

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

GET Yes
basepathmapping:by-base-path

Gets a BasePathMapping resource by using the specified identifier.

This link relation offers the following templated variable(s):

  • base_path: Required.

    The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.

GET Yes
basepathmapping:create

Creates a new BasePathMapping resource.

POST No


Properties

{
  "domainName" : "String",
  "certificateName" : "String",
  "certificateArn" : "String",
  "certificateUploadDate" : "Timestamp",
  "distributionDomainName" : "String"
}

  • domainName
  • The name of the DomainName resource.

  • certificateName
  • The name of the certificate.

  • certificateArn
  • The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

  • certificateUploadDate
  • The timestamp when the certificate was uploaded.

  • distributionDomainName
  • The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.

Remarks

See Also

Use Client-Side Certificate