TerrformでAuroraを作成するときにパッと見ることができるように、設定の一覧を作成しました。
構築するときなどの手助けになれば！
Terraformリファレンス
aws_rds_cluster
| 設定項目 | 解説 |
|---|---|
| allow_major_version_upgrade | メジャーアップデートを行うかどうかの設定。trueにしてapplyするとメジャーアップデートを行う。 |
| apply_immediately | クラスターへの設定変更の即時反映設定。trueにすると即時で行われ、falseにすると次回のメンテナスウィンドウで行われる。 |
| availability_zones | クラスターストレージを配置するAZ。リスト形式で指定する。指定された値が3つ以下の場合、自動的に3つのAZが割り当てられる。自動割当にする場合はlifecycleのignore_changesで無視することがオススメ。 |
| backtrack_window | バックトラックウィンドウ。指定できる範囲は、「0~259200（72時間）」。このオプションはauroraエンジンのみ利用可能。 |
| backup_retention_period | バックアップの保持期間。指定できる範囲は、「1~35（日）」。 |
| cluster_identifier | クラスターのユニーク識別子。 |
| copy_tags_to_snapshot | スナップショットにクラスターのタグ情報を全てコピーするかどうかの設定。 |
| database_name | クラスターに作成するDBの名前。 |
| db_cluster_parameter_grup_name | クラスターパラメータグループ。 |
| db_subnet_group | DBクラスターが使用するサブネットグループ。事前に作成しておく必要がある。少なくとも2つのAZに1つ以上のサブネットが必要。 |
| deletion_protection | クラスターの削除保護。trueなら有効。 |
| enable_http_endpoint | HTTPエンドポイントの有効化設定。serverlessのみ設定可能。 |
| enabled_cloudwatch_logs_exports | CloudWatchにログをエクスポートするかどうかの設定。リスト形式で以下を設定可能。 MySQL：audit, error, general, slowquery PostgreSQL：postgresql |
| engine_mode | エンジンモード。global、multimaster、parallelquery、provisioned、serverlessが設定可能。 ※parallelqueryはMySQLのみ使用可能。 |
| engine_version | データベースエンジンのバージョン。 MySQL：https://docs.aws.amazon.com/ja_jp/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.Versions.html PostgreSQL：https://docs.aws.amazon.com/ja_jp/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html |
| engine | データベースのエンジン。aurora、aurora-mysql、aurora-postgresqlが設定可能。 |
| final_snapshot_identifier | クラスターを削除するときにスナップショットを取得した場合、そのスナップショットの識別子。 |
| iam_database_authentication_enabled | IAMデータベース認証の設定。クラスターに接続するときにIAMで認証を行うかどうか設定できる。 |
| iam_roles | クラスターに関連付けるIAMロール。リスト形式で指定する。 |
| kms_key_id | KMSのキー識別子。 |
| master_password | DBユーザーのパスワード。lifecycleのignore_changesで無視することで、後からパスワードを変更しても差分として認識されずに済む。 |
| master_username | DBユーザー名。 |
| port | DBのポート。 |
| preferred_backup_window | 日次の自動バックアップウィンドウ。hh:mm-hh:mmの形式で実施したい時間帯を指定する。 例：10:00-10:30 |
| preferred_maintenance_window | メンテナンスウィンドウ。DDD:hh:mm-DDD:hh:mmの形式で実施したい時間帯を指定する。 例：web:04:00-web:04:30 |
| replication_source_identifier | レプリケーション元になるクラスター or インスタンスを指定する。DBがAuroraのみのときは使用することはない。 |
| restore_to_point_in_time | ポイントインタイムリカバリの設定。プロパティは後述。 |
| scaling_configuration | スケーリングのプロパティを設定する項目。serverlessのみ設定可能。プロパティの解説は後日予定。 |
| skip_final_snapshot | クラスターを削除するときにスナップショットを取得するかどうかの設定。trueならスナップショットを許可する。 |
| snapshot_identifier | スナップショットからクラスターを作成する場合に対象のスナップショットを指定する設定。 |
| storage_encrypted | ストレージを暗号化設定。trueなら有効。 |
| vpc_security_group_ids | クラスターに関連付けるセキュリティグループ。リスト形式で指定する。 |
| tags | タグ。 |
restore_to_point_in_timeのプロパティ
| 設定項目 | 解説 |
|---|---|
| source_cluster_identifier | リストア元のクラスター。 |
| restore_type | copy-on-write or full-copyを指定する。 copy-on-write：ボリュームは変更があったときに複製する方式。 |
| restore_to_time | リストアさせる日時（UTC）を指定する。 |
aws_rds_cluster_parameter_group
| 設定項目 | 解説 |
|---|---|
| name | パラメーターグループの名前。 |
| family | パラメータグループのファミリー。 |
| description | パラメータグループの説明。 |
| parameter | 適用するDBパラメーターの設定。プロパティは後述。 |
| tags | タグ。 |
parameterのプロパティ
| 設定項目 | 解説 |
|---|---|
| name | パラメータの名前。 |
| value | パラメータの設定値。 |
| apply_method | 変更を即時反映するか、再起動させるかの設定。immediate or pending-reboot のどちらかを指定する。 |
aws_rds_cluster_instance
| 設定項目 | 解説 |
|---|---|
| identifier | インスタンスの識別子。 |
| cluster_identifier | このインスタンスを起動させるクラスターを指定する。 |
| engine | データベースのエンジン。aurora、aurora-mysql、aurora-postgresqlが設定可能。aws_rds_clusterと同じにする必要がある。 |
| engine_version | データベースエンジンのバージョン。aws_rds_clusterと同じにする必要がある。 |
| instance_class | インスタンスのクラス。 |
| publicly_accessible | インターネットからのアクセスを許可設定。trueなら有効。 |
| db_subnet_group_name | DBクラスターが使用するサブネットグループ。aws_rds_clusterと同じにする必要がある。 |
| db_parameter_group_name | DBパラメータグループ。 |
| apply_immediately | インスタンスへの設定変更の即時反映設定。trueにすると即時で行われ、falseにすると次回のメンテナスウィンドウで行われる。 |
| monitoring_role_arn | 拡張モニタリングを使用するためのIAMロール。 |
| monitoring_interval | 拡張モニタリングの監視間隔。0、1、5、10、15、30、60が設定可能。 |
| promotion_tier | レプリカインスタンスがプライマリに昇格させる際の優先度。デフォルトは0。 |
| availability_zone | インスタンスを作成するAZを指定する。 |
| preferred_backup_window | 日次の自動バックアップウィンドウ。hh:mm-hh:mmの形式で実施したい時間帯を指定する。 例：10:00-10:30 |
| preferred_maintenance_window | メンテナンスウィンドウ。DDD:hh:mm-DDD:hh:mmの形式で実施したい時間帯を指定する。 例：web:04:00-web:04:30 |
| auto_minor_version_upgrade | マイナーバージョンの自動アップデート設定。trueなら有効。 |
| performance_insights_enabled | パフォーマンスインサイトの有効化。trueなら有効。 |
| performance_insights_kms_key_id | パフォーマンスインサイトの暗号化に使用するKMSのキー識別子。 |
| copy_tags_to_snapshot | スナップショットにクラスターのタグ情報を全てコピーするかどうかの設定。tureなら有効。 |
| ca_cert_identifier | 中間証明書の識別子。2021年3月22日時点では、「rds-ca-2019」が最新。 |
| tags | タグ。 |
aws_db_subnet_group
| 設定項目 | 解説 |
|---|---|
| name | サブネットグループの名前。 |
| description | サブネットグループの説明。 |
| subnet_ids | サブネットのID。リスト形式で指定する。 |
| tags | タグ。 |
随時更新予定。
コメント