Appsync: Add support for custom domains

[alextriaca]

Description

Appsync has recently added support for custom domains. The cloudformation for this can be found here (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html)

Use Case

Currently Appsync assigns a random URL when creating the API. If for some reason the API is ever deleted this URL is lost and a new and random URL is assigned. This means that you always have to consider updating those components that are dependent on the API as you cannot rely on the URL remaining the same. This change will remove that dependancy and allow users to create a custom URL that doesn't change even if the underlying API is rebuilt.

Proposed Solution

API Gateway already supports this and so a similar implementation would seem sensible. Something like:

domain_name = "test.my_domain.com"

certificate = Certificate(
    self,
    "certificate",
    domain_name=domain_name,
    subject_alternative_names=[domain_name],
    validation_method=ValidationMethod.DNS,
)

domain_name_options = DomainNameOptions(
    certificate=certificate, domain_name=domain_name
)

api = aws_appsync.GraphqlApi(
    self,
    "my_api",
    name="my_api",
    schema=aws_appsync.Schema.from_asset("resources/schema.graphql"),
    domain_name=domain_name_options,
)

Other information

No response

Acknowledge

• I may be able to implement this feature request
• This feature might incur a breaking change

[joekendal]

+1

[sammy2077]

Currently doing it this way via CDK (v2) - Typescript

        // create appsync domain
        const appsyncDomain = new CfnDomainName(this, 'AppsyncDomainName', {
            certificateArn: 'your arn',
            domainName: 'api.example.com',
            description: 'Domain name for AppSync Api',
        })

       // associate domain
        new CfnDomainNameApiAssociation(this, 'AppsyncDomainNameApiAssociation', {
            apiId: this.api.attrApiId,
            domainName: appsyncDomain.attrDomainName,
        });


   
        const hostedZoneId = 'ZONE ID HERE'
       const zoneName = 'example.com'

       // hosten zone for adding appsync domain
        const zone = HostedZone.fromHostedZoneAttributes(this, `HostedZone`, {
            hostedZoneId,
            zoneName,
        });

         // create a cname to the appsync domain. will map to something like xxxx.cloudfront.net
        new CnameRecord(this, `CnameApiRecord`, {
            recordName: 'api',
            zone,
            domainName: appsyncDomain.attrAppSyncDomainName
        });

[daveharig]

+1

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.