【Terraform】Auroraのリファレンス。(困ったらとりあえずコレ!)

terraform-aurora-reference Aurora
スポンサーリンク

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_groupDBクラスターが使用するサブネットグループ。事前に作成しておく必要がある。少なくとも2つのAZに1つ以上のサブネットが必要。
deletion_protectionクラスターの削除保護。trueなら有効。
enable_http_endpointHTTPエンドポイントの有効化設定。serverlessのみ設定可能。
enabled_cloudwatch_logs_exportsCloudWatchにログをエクスポートするかどうかの設定。リスト形式で以下を設定可能。
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_enabledIAMデータベース認証の設定。クラスターに接続するときにIAMで認証を行うかどうか設定できる。
iam_rolesクラスターに関連付けるIAMロール。リスト形式で指定する。
kms_key_idKMSのキー識別子。
master_passwordDBユーザーのパスワード。lifecycleのignore_changesで無視することで、後からパスワードを変更しても差分として認識されずに済む。
master_usernameDBユーザー名。
portDBのポート。
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_typecopy-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_nameDBクラスターが使用するサブネットグループ。aws_rds_clusterと同じにする必要がある。
db_parameter_group_nameDBパラメータグループ。
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タグ。

随時更新予定。

プロフィール
この記事を書いた人
katsuya

SESからキャリアをスタートし、現在はフリーランスとして活動しています。フリーランスになってから6年で年収1,000万円を達成しました。「Study Infra」では、今までの経験やITインフラに関する情報を発信中です。

katsuyaをフォローする
AuroraAWSTerraform
スポンサーリンク
シェアする
katsuyaをフォローする

コメント

タイトルとURLをコピーしました