最近CDKでAWSのリソースを構築するのにハマっています。その中でAPI Gatewayを作って、そこにカスタムドメインを被せる方法で若干ハマったので記事にしたいと思います。
今回はCDKでAPI Gatewayを作ってカスタムドメインの設定をするところまでに焦点をあてます。
カスタムドメインとは、あらかじめ取得しておいたドメインや証明書を使って、本来ならランダムで割り当てられるAPI Gatewayのドメインを自由に設定できる機能です。
手動でポチポチやると簡単ですが、CDKで構築するとなると登場要素が多くて少し面倒です。
以下に前提条件を記載します。ドメイン取得や証明書取得については全てAWS内で行っている(Route53とACMを使っている)ものとします。
従ってそれらを利用可能なリージョン(例えばus-east-1とか)で実行する必要があります。
ドメイン取得済み
証明書取得済み
ARNを把握していることCDKのコードを見る前に、手動でカスタムドメインを設定する場合の手順について説明します。
API Gatewayの画面からカスタムドメインを作成
API Gatewayは同一API上に「ステージ」としていくつか環境を持てるので、「このドメインはこのステージ」的な設定(APIマッピング)をすることもできますRoute53の対象ドメインのホストゾーン(DNS)にエイリアスレコードを追加
API Gateway側で指定したカスタムドメイン」を紐付けます実際のコードは下記のようになります。
import * as cdk from 'aws-cdk-lib';
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
import * as acm from 'aws-cdk-lib/aws-certificatemanager';
import * as route53 from 'aws-cdk-lib/aws-route53';
import * as targets from 'aws-cdk-lib/aws-route53-targets';
export class SampleStack extends cdk.Stack {
// ドメイン
private DOMAIN = 'nekoniki.com';
// Route53のホストゾーンID
private HOSTED_ZONE_ID = 'XXXXXXXXXXXXXXXXXXX';
// Route53のホストゾーン名
private HOSTED_ZONE_NAME = 'nekoniki.com.';
// 取得した証明書(ACM)のARN
private ACM_ARN = 'arn:XXXXXXXXXXXXXXXXXXXXXXXXXX';
constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// プレフィックス
// このスタックを複数環境に分けて走らせたい場合は、このパラメータを引数として受け取ったりするように作り替えるとGood
const prefix = 'AnyPrefix';
// API Gatewayの作成
const api = new apigateway.RestApi(this, `${prefix}Api`, {
// 諸々の設定
cloudWatchRole: false,
defaultCorsPreflightOptions: {
allowOrigins: apigateway.Cors.ALL_ORIGINS,
allowMethods: apigateway.Cors.ALL_METHODS,
allowHeaders: apigateway.Cors.DEFAULT_HEADERS,
statusCode: 200,
},
});
// カスタムドメインの設定
const domain = api.addDomainName(`${prefix}ApiDomain`, {
// ドメインは"api.nekoniki.com"とする
domainName: `api.${this.DOMAIN}`,
// ARNから証明書を取得して紐づける
certificate: acm.Certificate.fromCertificateArn(this, `${prefix}Cetrificate`, this.ACM_ARN),
// TLS1.2
securityPolicy: apigateway.SecurityPolicy.TLS_1_2,
// エンドポイント種別はリージョナルに
endpointType: apigateway.EndpointType.REGIONAL,
});
// Route53にドメイン→API GatewayのカスタムドメインのAレコードを作成
new route53.ARecord(this, `${prefix}ApiGatewayARecord`, {
// ホストゾーン情報(IDと名前から逆引きする)
zone: route53.HostedZone.fromHostedZoneAttributes(this, `${prefix}HostedZone`, {
hostedZoneId: this.HOSTED_ZONE_ID,
zoneName: this.HOSTED_ZONE_NAME,
}),
// レコード名はカスタムドメインを指定
recordName: `api.${this.DOMAIN}`,
// ターゲットは先ほど作成したAPI Gatewayのカスタムドメイン本体
target: route53.RecordTarget.fromAlias(new targets.ApiGatewayDomain(domain)),
});
}
}先ほど箇条書きで書いた手順をコードに起こすとそれなりの量になるのが分かります。
今回はCDKを使ってAPI Gatewayのカスタムドメインを作り、それに付随するDNSのレコード設定等々の作業をまとめたものを紹介しました。
CloudFrontなどもそうですが、証明書やドメイン周りはどうしても事前に取得した情報を使い回す形が自然になるので、今回のようなコード形態になるかなと思います。
最近、「CDKで○◯を作る方法をレクチャーしてほしい」といった要望をいただくことがちらほらあるのですが、引き続きお問い合わせのページから募集しておりますので、お気軽にご連絡ください。 今回の内容が役立ちましたら幸いです。