AWS CDK で Amazon RDS オプショングループに物理名を設定する方法

AWS CDKでAmazon RDSリソースを構築する際、「なぜParameterGroupでは名前を直接設定できるのに、OptionGroupではできないのか？」という疑問を持ったことはありませんか？

実際にコードを書いてみると、ParameterGroupではnameプロパティが使えるものの、OptionGroupでは同じようにはいきません。
統一された命名規則を適用したいプロジェクトでは、この違いが思わぬ障害となることがあります。

この記事では、AWS CDKの公式ドキュメントを参照しながら、OptionGroupで物理名を設定する方法について詳しく解説します。

問題：OptionGroupに名前設定プロパティが存在しない
1. OptionGroup（名前設定不可）
CDK APIドキュメントとの対比
1. ParameterGroup（名前設定可能）
解決策：エスケープハッチを使用した物理名設定
1. エスケープハッチの動作原理
なぜエスケープハッチが必要なのか
まとめ

問題：OptionGroupに名前設定プロパティが存在しない

AWS CDK公式ドキュメントのOptionGroupプロパティを確認すると、以下のプロパティのみが提供されています。

class OptionGroup (construct) · AWS CDK

# class OptionGroup (construct)

configurations? – オプションの設定
description? – オプショングループの説明
engine – データベースエンジン

注目すべき点は、ParameterGroupには存在するnameプロパティが、OptionGroupには存在しないということです。

OptionGroup（名前設定不可）

// ❌ OptionGroupには物理名を設定するプロパティが存在しない
const optionGroup = new rds.OptionGroup(this, 'RDS-OptionGroup', {
engine: rds.DatabaseInstanceEngine.mariaDb({
version: rds.MariaDbEngineVersion.VER_11_4_5
}),
configurations: [],
// optionGroupName: "..." // このプロパティは存在しない
// name: "..." // このプロパティも存在しない
});

この制限により、統一された命名規則を適用したい場合や、既存リソースとの互換性を保つ必要がある場合に問題となります。

CDK APIドキュメントとの対比

同じRDSリソースでも、ParameterGroupとOptionGroupで提供されているプロパティが異なります。

class ParameterGroup (construct) · AWS CDK

# class ParameterGroup (construct)

ParameterGroup（名前設定可能）

// ✅ ParameterGroupには name プロパティが存在
const parameterGroup = new rds.ParameterGroup(this, 'RDS-ParameterGroup', {
engine: rds.DatabaseInstanceEngine.mariaDb({
version: rds.MariaDbEngineVersion.VER_11_4_5
}),
parameters: {
character_set_server: 'utf8mb4',
character_set_client: 'utf8mb4',
collation_server: 'utf8mb4_unicode_ci',
},
name: 'ParameterGroup' // 直接指定可能
});

解決策：エスケープハッチを使用した物理名設定

この問題を解決するには、CDKのエスケープハッチ機能を使用してCloudFormationのAWS::RDS::OptionGroupリソースのOptionGroupNameプロパティを直接操作する必要があります。

/**
* オプショングループの作成
*/
const optionGroup = new rds.OptionGroup(this, 'RDS-OptionGroup', {
engine: rds.DatabaseInstanceEngine.mariaDb({
version: rds.MariaDbEngineVersion.VER_11_4_5
}),
configurations: [] // MariaDBでは通常空で問題なし
});
Tags.of(optionGroup).add('App', 'Cpe');

// エスケープハッチでオプショングループの物理名を設定
const cfnOptionGroup = optionGroup.node.defaultChild as rds.CfnOptionGroup;
cfnOptionGroup.addPropertyOverride('OptionGroupName', `OptionGroup`);