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-a custom domain name for the 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 the 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 roo T certificate. Use the intermediate certificates provided by your certificate authority. Do not include any intermediaries that is 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 was being created, the console displays the following information to a alias RESOURC E record created in your DNS provider to map your custom domain name ( api.example.com
) to the API ' s CloudFront distribution domain n Ame ( distribution-id
.cloudfront.net
).
AWS API Gateway Domain name