Set Up a Custom Domain Name for an API Gateway API
The following procedure describes how to set up a custom domain name.
To set up a custom domain name for an API Gateway API
-
Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.
-
Choose Custom Domain Names from the main navigation pane.
-
Choose Create in the secondary navigation pane.
-
In Create Custom Domain Name, specify the following:
-
For Domain name, type your domain name (for example,
api.example.com
). -
For Certificate name, type a name for future reference (for example,
my-example-certificate
). -
For Certificate body, type or paste the body of the PEM-formatted server certificate from your certificate authority. The following shows an abbreviated example of such a certificate.
-----BEGIN CERTIFICATE----- EXAMPLECA+KgAwIBAgIQJ1XxJ8Pl++gOfQtj0IBoqDANBgkqhkiG9w0BAQUFADBB ... az8Cg1aicxLBQ7EaWIhhgEXAMPLE -----END CERTIFICATE-----
-
For Certificate private key, type or paste your PEM-formatted certificate's private key. The following shows an abbreviated example of such a key.
-----BEGIN RSA PRIVATE KEY----- EXAMPLEBAAKCAQEA2Qb3LDHD7StY7Wj6U2/opV6Xu37qUCCkeDWhwpZMYJ9/nETO ... 1qGvJ3u04vdnzaYN5WoyN5LFckrlA71+CszD1CGSqbVDWEXAMPLE -----END RSA PRIVATE KEY-----
-
For Certificate chain, type or paste the PEM-formatted intermediate certificates and, optionally, the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path. The following shows an abbreviated example.
-----BEGIN CERTIFICATE----- EXAMPLECA4ugAwIBAgIQWrYdrB5NogYUx1U9Pamy3DANBgkqhkiG9w0BAQUFADCB ... 8/ifBlIK3se2e4/hEfcEejX/arxbx1BJCHBvlEPNnsdw8EXAMPLE -----END CERTIFICATE-----
Here is another example.
-----BEGIN CERTIFICATE-----
Intermediate certificate 2
-----END CERTIFICATE----- -----BEGIN CERTIFICATE-----Intermediate certificate 1
-----END CERTIFICATE----- -----BEGIN CERTIFICATE-----Optional: Root certificate
-----END CERTIFICATE-----
-
-
Choose Save.
-
While the new custom domain name is being created, the console displays the following information to have an alias resource record created in your DNS provider to map your custom domain name (
api.example.com
) to the API's CloudFront distribution domain name (
).distribution-id
.cloudfront.net