feat: configure custom domain for API (#80)

---------

Co-authored-by: Pete Gadomski <[email protected]>

Author: hrodmn

.github/workflows/ci.yml

@@ -53,6 +53,8 @@ jobs:
       STACK_BUCKET_NAME: stac-fastapi-geoparquet-labs-375
       STACK_COLLECTIONS_KEY: collections.json
       STACK_RATE_LIMIT: 10
+      STACK_API_CUSTOM_DOMAIN: ${{ vars.API_CUSTOM_DOMAIN }}
+      STACK_ACM_CERTIFICATE_ARN: ${{ vars.ACM_CERTIFICATE_ARN }}
     environment:
       name: development
       url: ${{ steps.deploy.outputs.api_url }}

docs/katas/8_planetary_computer.ipynb

@@ -1318,6 +1318,7 @@
     "YEARS = [2024]\n",
     "number_of_items = 0\n",
     "\n",
+    "\n",
     "def clean_dict(item: dict[str, Any]) -> dict[str, Any]:\n",
     "    for key, value in item.items():\n",
     "        if hasattr(value, \"tolist\"):\n",
@@ -1328,6 +1329,7 @@
     "            item[key] = clean_dict(value)\n",
     "    return item\n",
     "\n",
+    "\n",
     "Path(\"/Users/gadomski/Desktop/sentinel-2-l2a-fixed.parquet\").mkdir(exist_ok=True)\n",
     "\n",
     "for path in Path(\"/Users/gadomski/Desktop/sentinel-2-l2a.parquet\").glob(\"*.parquet\"):\n",
@@ -1337,9 +1339,7 @@
     "        items = []\n",
     "        for feature in tqdm(feature_collection[\"features\"]):\n",
     "            item = clean_dict(feature[\"properties\"])\n",
-    "            new_item = {\n",
-    "                \"geometry\": feature[\"geometry\"]\n",
-    "            }\n",
+    "            new_item = {\"geometry\": feature[\"geometry\"]}\n",
     "            properties = {}\n",
     "            for key, value in item.items():\n",
     "                if key in TOP_LEVEL_ATTRIBUTES:\n",
@@ -1355,7 +1355,7 @@
     "            ),\n",
     "            items,\n",
     "        )\n",
-    "        print(number_of_items, \"items\")\n"
+    "        print(number_of_items, \"items\")"
    ]
   },
   {

infrastructure/aws/config.py

@@ -30,6 +30,10 @@ class Config(BaseSettings):
         "maximum average requests per second over an extended period of time",
     ] = 10
 
+    # custom domain
+    api_custom_domain: Optional[str] = None
+    acm_certificate_arn: Optional[str] = None
+
     # vpc
     nat_gateway_count: int = 0
 

infrastructure/aws/stacks/app.py

@@ -46,5 +46,25 @@ def __init__(
         geoparquet_api = GeoparquetApiLambda(
             self, "geoparquet-api", config=config, bucket=bucket
         )
-        assert geoparquet_api.url
-        CfnOutput(self, "GeoparquetApiURL", value=geoparquet_api.url)
+
+        if geoparquet_api.domain_name:
+            CfnOutput(
+                self,
+                "ApiGatewayDomainNameTarget",
+                value=geoparquet_api.domain_name.regional_domain_name,
+                description="The target for the CNAME/ALIAS record",
+            )
+            CfnOutput(
+                self,
+                "GeoparquetApiURL",
+                value=f"https://{geoparquet_api.domain_name.name}",
+                description="The custom domain URL for the API",
+            )
+        else:
+            assert geoparquet_api.stage.url
+            CfnOutput(
+                self,
+                "GeoparquetApiURL",
+                value=geoparquet_api.stage.url,
+                description="The default stage URL for the API",
+            )

infrastructure/aws/stacks/constructs/geoparquet_api_lambda.py

@@ -4,8 +4,17 @@
 from aws_cdk import (
     Duration,
 )
-from aws_cdk.aws_apigatewayv2 import HttpApi, HttpStage, ThrottleSettings
+from aws_cdk.aws_apigatewayv2 import (
+    DomainMappingOptions,
+    DomainName,
+    HttpApi,
+    HttpStage,
+    MappingValue,
+    ParameterMapping,
+    ThrottleSettings,
+)
 from aws_cdk.aws_apigatewayv2_integrations import HttpLambdaIntegration
+from aws_cdk.aws_certificatemanager import Certificate
 from aws_cdk.aws_lambda import Code, Function, Handler, Runtime
 from aws_cdk.aws_logs import RetentionDays
 from config import Config
@@ -42,20 +51,46 @@ def __init__(
             },
         )
         bucket.bucket.grant_read(api_lambda)
-        api = HttpApi(
+
+        self.domain_name = (
+            DomainName(
+                self,
+                "api-domain-name",
+                domain_name=config.api_custom_domain,
+                certificate=Certificate.from_certificate_arn(
+                    self,
+                    "api-cdn-certificate",
+                    certificate_arn=config.acm_certificate_arn,
+                ),
+            )
+            if config.api_custom_domain and config.acm_certificate_arn
+            else None
+        )
+
+        self.api = HttpApi(
             scope=self,
             id="api",
             default_integration=HttpLambdaIntegration(
                 "api-integration",
                 handler=api_lambda,
+                parameter_mapping=ParameterMapping().overwrite_header(
+                    "host", MappingValue.custom(self.domain_name.name)
+                )
+                if self.domain_name
+                else None,
             ),
-            default_domain_mapping=None,  # TODO: enable custom domain name
+            default_domain_mapping=DomainMappingOptions(
+                domain_name=self.domain_name,
+            )
+            if self.domain_name
+            else None,
             create_default_stage=False,  # Important: disable default stage creation
         )
-        stage = HttpStage(
+
+        self.stage = HttpStage(
             self,
             "api-stage",
-            http_api=api,
+            http_api=self.api,
             auto_deploy=True,
             stage_name="$default",
             throttle=ThrottleSettings(
@@ -65,4 +100,3 @@ def __init__(
             if config.rate_limit
             else None,
         )
-        self.url = stage.url