| allow_major_version_upgrade |
Specifies whether major version upgrades are allowed. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_cluster#allow_major_version_upgrade |
bool |
false |
no |
| apply_immediately |
Specifies whether any cluster modifications are applied immediately, or during the next maintenance window |
bool |
true |
no |
| auto_minor_version_upgrade |
Specifies whether any minor engine upgrades will be applied automatically to the DB instance during the maintenance window or not |
bool |
true |
no |
| backup_retention_period |
Backup retention period |
number |
n/a |
yes |
| ca_cert_identifier |
The identifier of the CA certificate for the DB instance |
string |
null |
no |
| cluster_family |
The family of the DocumentDB cluster parameter group. For more details, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html |
string |
"docdb5.0" |
no |
| cluster_parameters |
List of DB parameters to apply |
list(object({
apply_method = string
name = string
value = string
})) |
[] |
no |
| db_port |
DocumentDB port |
number |
27017 |
no |
| deletion_protection |
A value that indicates whether the DB cluster has deletion protection enabled |
bool |
false |
no |
| enable_performance_insights |
Specifies whether to enable Performance Insights for the DB Instance. |
bool |
false |
no |
| enabled_cloudwatch_logs_exports |
List of log types to export to cloudwatch. The following log types are supported: audit, profiler |
list(string) |
[] |
no |
| engine |
The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb |
string |
"docdb" |
no |
| engine_version |
The version number of the database engine to use |
string |
"5.0.0" |
no |
| instance_class |
The instance class to use. For more details, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-classes.html#db-instance-class-specs |
string |
"db.t3.medium" |
no |
| instance_count |
Number of DB instances to create in the cluster |
number |
1 |
no |
| kms_key_alias |
The alias for the KMS encryption key. When specifying kms_key_alias, storage_encrypted needs to be set to true |
string |
"alias/aws/rds" |
no |
| master_password |
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints |
string |
n/a |
yes |
| master_username |
Username for the master DB user |
string |
n/a |
yes |
| name |
DocumentDB name |
string |
n/a |
yes |
| preferred_backup_window |
Daily time range during which the backups happen |
string |
"07:00-09:00" |
no |
| preferred_maintenance_window |
The window to perform maintenance in. Syntax: ddd:hh24:mi-ddd:hh24:mi. |
string |
"Mon:22:00-Mon:23:00" |
no |
| skip_final_snapshot |
Determines whether a final DB snapshot is created before the DB cluster is deleted |
bool |
true |
no |
| storage_encrypted |
Specifies whether the DB cluster is encrypted |
bool |
true |
no |
| storage_type |
The storage type to associate with the DB cluster. Valid values: standard, iopt1 |
string |
"standard" |
no |
| subnet_ids |
List of VPC subnet IDs to place DocumentDB instances in |
list(string) |
[] |
no |
| vpc_security_group_ids |
VPC security groups for DocumentDB |
list(string) |
[] |
no |