| Name | Version |
|---|---|
| aws | >= 5.0.0 |
| Name | Version |
|---|---|
| aws | >= 5.0.0 |
| random | n/a |
| Name | Source | Version |
|---|---|---|
| security_group | terraform-aws-modules/security-group/aws | ~> 4.0 |
| Name | Type |
|---|---|
| aws_docdb_cluster.this | resource |
| aws_docdb_cluster_instance.this | resource |
| aws_docdb_cluster_parameter_group.this | resource |
| aws_secretsmanager_secret.secret | resource |
| aws_secretsmanager_secret_version.secret | resource |
| random_password.rds_password | resource |
| aws_vpc.main | data source |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| apply_immediately | Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. | string |
"true" |
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 |
"docdb4.0" |
no |
| cluster_size | Number of DB instances to create in the cluster | string |
"2" |
no |
| db_name | Name of the database. | string |
n/a | yes |
| enabled_cloudwatch_logs_exports | List of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquery. | 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 |
"" |
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 |
| kms_key_id | The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true. |
string |
"" |
no |
| master_password | (Required unless a snapshot_identifier is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. | string |
"" |
no |
| master_username | (Required unless a snapshot_identifier is provided) Username for the master DB user. | string |
"root" |
no |
| name | Name to be used on all the resources as identifier | string |
"" |
no |
| port | Open port in sg for db communication. | number |
27017 |
no |
| preferred_backup_window | Daily time range during which the backups happen. | string |
"07:00-09:00" |
no |
| retention_period | Number of days to retain backups for. | string |
"7" |
no |
| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB cluster is deleted. | string |
"false" |
no |
| snapshot_identifier | Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. | string |
"" |
no |
| storage_encrypted | Specifies whether the DB cluster is encrypted. | string |
"false" |
no |
| subnet_group | Database subnet group to use. Leave blank to create a new one. | string |
"" |
no |
| tags | Any extra tags to assign to objects | map(any) |
{} |
no |
| tls_enabled | When true than cluster using TLS for communication. | bool |
false |
no |
| vpc_id | ID of the VPC to deploy database into. | string |
n/a | yes |
| Name | Description |
|---|---|
| arn | Amazon Resource Name (ARN) of the cluster. |
| cluster_name | Cluster Identifier. |
| connection_secret_arn | The ARN of the AWS Secrets Manager secret created |
| connection_secret_name | The name of the AWS Secrets Manager secret created |
| master_password | password for the master DB user. |
| master_username | Username for the master DB user. |
| reader_endpoint | A read-only endpoint of the DocumentDB cluster, automatically load-balanced across replicas. |
| writer_endpoint | Endpoint of the DocumentDB cluster. |