You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Fine grained control of individual cluster instances
15
15
- Custom endpoints
16
16
- RDS multi-AZ support (not Aurora)
17
+
- Aurora Limitless
17
18
18
19
## Usage
19
20
@@ -207,6 +208,7 @@ module "cluster" {
207
208
## Examples
208
209
209
210
-[Autoscaling](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tree/master/examples/autoscaling): A PostgreSQL cluster with enhanced monitoring and autoscaling enabled
211
+
-[Limitless](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tree/master/examples/limitless): A PostgreSQL Limitless cluster
210
212
-[Global Cluster](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tree/master/examples/global-cluster): A PostgreSQL global cluster with clusters provisioned in two different region
211
213
-[Multi-AZ](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tree/master/examples/multi-az): A multi-AZ RDS cluster (not using Aurora engine)
212
214
-[MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tree/master/examples/mysql): A simple MySQL cluster
@@ -224,13 +226,13 @@ Terraform documentation is generated automatically using [pre-commit hooks](http
| <aname="input_cluster_performance_insights_enabled"></a> [cluster\_performance\_insights\_enabled](#input\_cluster\_performance\_insights\_enabled)| Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster |`bool`|`null`| no |
291
294
| <aname="input_cluster_performance_insights_kms_key_id"></a> [cluster\_performance\_insights\_kms\_key\_id](#input\_cluster\_performance\_insights\_kms\_key\_id)| Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds) |`string`|`null`| no |
292
295
| <aname="input_cluster_performance_insights_retention_period"></a> [cluster\_performance\_insights\_retention\_period](#input\_cluster\_performance\_insights\_retention\_period)| Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731 |`number`|`null`| no |
296
+
| <aname="input_cluster_scalability_type"></a> [cluster\_scalability\_type](#input\_cluster\_scalability\_type)| Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation. Valid values: limitless, standard |`string`|`null`| no |
293
297
| <aname="input_cluster_tags"></a> [cluster\_tags](#input\_cluster\_tags)| A map of tags to add to only the cluster. Used for AWS Instance Scheduler tagging |`map(string)`|`{}`| no |
294
298
| <aname="input_cluster_timeouts"></a> [cluster\_timeouts](#input\_cluster\_timeouts)| Create, update, and delete timeout configurations for the cluster |`map(string)`|`{}`| no |
295
299
| <aname="input_cluster_use_name_prefix"></a> [cluster\_use\_name\_prefix](#input\_cluster\_use\_name\_prefix)| Whether to use `name` as a prefix for the cluster |`bool`|`false`| no |
300
+
| <aname="input_compute_redundancy"></a> [compute\_redundancy](#input\_compute\_redundancy)| Specifies whether to create standby DB shard groups for the DB shard group |`number`|`null`| no |
296
301
| <aname="input_copy_tags_to_snapshot"></a> [copy\_tags\_to\_snapshot](#input\_copy\_tags\_to\_snapshot)| Copy all Cluster `tags` to snapshots |`bool`|`null`| no |
297
302
| <aname="input_create"></a> [create](#input\_create)| Whether cluster should be created (affects nearly all resources) |`bool`|`true`| no |
298
303
| <aname="input_create_cloudwatch_log_group"></a> [create\_cloudwatch\_log\_group](#input\_create\_cloudwatch\_log\_group)| Determines whether a CloudWatch log group is created for each `enabled_cloudwatch_logs_exports`|`bool`|`false`| no |
@@ -302,6 +307,8 @@ No modules.
302
307
| <aname="input_create_db_subnet_group"></a> [create\_db\_subnet\_group](#input\_create\_db\_subnet\_group)| Determines whether to create the database subnet group or use existing |`bool`|`false`| no |
303
308
| <aname="input_create_monitoring_role"></a> [create\_monitoring\_role](#input\_create\_monitoring\_role)| Determines whether to create the IAM role for RDS enhanced monitoring |`bool`|`true`| no |
304
309
| <aname="input_create_security_group"></a> [create\_security\_group](#input\_create\_security\_group)| Determines whether to create security group for RDS cluster |`bool`|`true`| no |
310
+
| <aname="input_create_shard_group"></a> [create\_shard\_group](#input\_create\_shard\_group)| Whether to create a shard group resource |`bool`|`false`| no |
311
+
| <aname="input_database_insights_mode"></a> [database\_insights\_mode](#input\_database\_insights\_mode)| The mode of Database Insights to enable for the DB cluster. Valid values: standard, advanced |`string`|`null`| no |
305
312
| <aname="input_database_name"></a> [database\_name](#input\_database\_name)| Name for an automatically created database on cluster creation |`string`|`null`| no |
306
313
| <aname="input_db_cluster_activity_stream_kms_key_id"></a> [db\_cluster\_activity\_stream\_kms\_key\_id](#input\_db\_cluster\_activity\_stream\_kms\_key\_id)| The AWS KMS key identifier for encrypting messages in the database activity stream |`string`|`null`| no |
307
314
| <aname="input_db_cluster_activity_stream_mode"></a> [db\_cluster\_activity\_stream\_mode](#input\_db\_cluster\_activity\_stream\_mode)| Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. One of: sync, async |`string`|`null`| no |
@@ -317,6 +324,7 @@ No modules.
317
324
| <aname="input_db_parameter_group_name"></a> [db\_parameter\_group\_name](#input\_db\_parameter\_group\_name)| The name of the DB parameter group |`string`|`null`| no |
318
325
| <aname="input_db_parameter_group_parameters"></a> [db\_parameter\_group\_parameters](#input\_db\_parameter\_group\_parameters)| A list of DB parameters to apply. Note that parameters may differ from a family to an other |`list(map(string))`|`[]`| no |
319
326
| <aname="input_db_parameter_group_use_name_prefix"></a> [db\_parameter\_group\_use\_name\_prefix](#input\_db\_parameter\_group\_use\_name\_prefix)| Determines whether the DB parameter group name is used as a prefix |`bool`|`true`| no |
327
+
| <aname="input_db_shard_group_identifier"></a> [db\_shard\_group\_identifier](#input\_db\_shard\_group\_identifier)| The name of the DB shard group |`string`|`null`| no |
320
328
| <aname="input_db_subnet_group_name"></a> [db\_subnet\_group\_name](#input\_db\_subnet\_group\_name)| The name of the subnet group name (existing or created) |`string`|`""`| no |
321
329
| <aname="input_delete_automated_backups"></a> [delete\_automated\_backups](#input\_delete\_automated\_backups)| Specifies whether to remove automated backups immediately after the DB cluster is deleted |`bool`|`null`| no |
322
330
| <aname="input_deletion_protection"></a> [deletion\_protection](#input\_deletion\_protection)| If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`|`bool`|`null`| no |
@@ -360,6 +368,8 @@ No modules.
360
368
| <aname="input_master_user_password_rotation_schedule_expression"></a> [master\_user\_password\_rotation\_schedule\_expression](#input\_master\_user\_password\_rotation\_schedule\_expression)| A cron() or rate() expression that defines the schedule for rotating your secret. Either `master_user_password_rotation_automatically_after_days` or `master_user_password_rotation_schedule_expression` must be specified |`string`|`null`| no |
361
369
| <aname="input_master_user_secret_kms_key_id"></a> [master\_user\_secret\_kms\_key\_id](#input\_master\_user\_secret\_kms\_key\_id)| The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key |`string`|`null`| no |
362
370
| <aname="input_master_username"></a> [master\_username](#input\_master\_username)| Username for the master DB user. Required unless `snapshot_identifier` or `replication_source_identifier` is provided or unless a `global_cluster_identifier` is provided when the cluster is the secondary cluster of a global database |`string`|`null`| no |
371
+
| <aname="input_max_acu"></a> [max\_acu](#input\_max\_acu)| The maximum capacity of the DB shard group in Aurora capacity units (ACUs) |`number`|`null`| no |
372
+
| <aname="input_min_acu"></a> [min\_acu](#input\_min\_acu)| The minimum capacity of the DB shard group in Aurora capacity units (ACUs) |`number`|`null`| no |
363
373
| <aname="input_monitoring_interval"></a> [monitoring\_interval](#input\_monitoring\_interval)| The interval, in seconds, between points when Enhanced Monitoring metrics are collected for instances. Set to `0` to disable. Default is `0`|`number`|`0`| no |
364
374
| <aname="input_monitoring_role_arn"></a> [monitoring\_role\_arn](#input\_monitoring\_role\_arn)| IAM role used by RDS to send enhanced monitoring metrics to CloudWatch |`string`|`""`| no |
365
375
| <aname="input_name"></a> [name](#input\_name)| Name used across resources created |`string`|`""`| no |
@@ -383,6 +393,8 @@ No modules.
383
393
| <aname="input_security_group_tags"></a> [security\_group\_tags](#input\_security\_group\_tags)| Additional tags for the security group |`map(string)`|`{}`| no |
384
394
| <aname="input_security_group_use_name_prefix"></a> [security\_group\_use\_name\_prefix](#input\_security\_group\_use\_name\_prefix)| Determines whether the security group name (`var.name`) is used as a prefix |`bool`|`true`| no |
385
395
| <aname="input_serverlessv2_scaling_configuration"></a> [serverlessv2\_scaling\_configuration](#input\_serverlessv2\_scaling\_configuration)| Map of nested attributes with serverless v2 scaling properties. Only valid when `engine_mode` is set to `provisioned`|`map(string)`|`{}`| no |
396
+
| <aname="input_shard_group_tags"></a> [shard\_group\_tags](#input\_shard\_group\_tags)| Additional tags for the shard group |`map(string)`|`{}`| no |
397
+
| <aname="input_shard_group_timeouts"></a> [shard\_group\_timeouts](#input\_shard\_group\_timeouts)| Create, update, and delete timeout configurations for the shard group |`map(string)`|`{}`| no |
386
398
| <aname="input_skip_final_snapshot"></a> [skip\_final\_snapshot](#input\_skip\_final\_snapshot)| Determines whether a final snapshot is created before the cluster is deleted. If true is specified, no snapshot is created |`bool`|`false`| no |
387
399
| <aname="input_snapshot_identifier"></a> [snapshot\_identifier](#input\_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`|`null`| no |
388
400
| <aname="input_source_region"></a> [source\_region](#input\_source\_region)| The source region for an encrypted replica DB cluster |`string`|`null`| no |
@@ -422,6 +434,9 @@ No modules.
422
434
| <aname="output_db_cluster_secretsmanager_secret_rotation_enabled"></a> [db\_cluster\_secretsmanager\_secret\_rotation\_enabled](#output\_db\_cluster\_secretsmanager\_secret\_rotation\_enabled)| Specifies whether automatic rotation is enabled for the secret |
423
435
| <aname="output_db_parameter_group_arn"></a> [db\_parameter\_group\_arn](#output\_db\_parameter\_group\_arn)| The ARN of the DB parameter group created |
424
436
| <aname="output_db_parameter_group_id"></a> [db\_parameter\_group\_id](#output\_db\_parameter\_group\_id)| The ID of the DB parameter group created |
437
+
| <aname="output_db_shard_group_arn"></a> [db\_shard\_group\_arn](#output\_db\_shard\_group\_arn)| ARN of the shard group |
438
+
| <aname="output_db_shard_group_endpoint"></a> [db\_shard\_group\_endpoint](#output\_db\_shard\_group\_endpoint)| The connection endpoint for the DB shard group |
439
+
| <aname="output_db_shard_group_resource_id"></a> [db\_shard\_group\_resource\_id](#output\_db\_shard\_group\_resource\_id)| The AWS Region-unique, immutable identifier for the DB shard group |
425
440
| <aname="output_db_subnet_group_name"></a> [db\_subnet\_group\_name](#output\_db\_subnet\_group\_name)| The db subnet group name |
426
441
| <aname="output_enhanced_monitoring_iam_role_arn"></a> [enhanced\_monitoring\_iam\_role\_arn](#output\_enhanced\_monitoring\_iam\_role\_arn)| The Amazon Resource Name (ARN) specifying the enhanced monitoring role |
427
442
| <aname="output_enhanced_monitoring_iam_role_name"></a> [enhanced\_monitoring\_iam\_role\_name](#output\_enhanced\_monitoring\_iam\_role\_name)| The name of the enhanced monitoring role |
|[aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones)| data source |
47
+
48
+
## Inputs
49
+
50
+
No inputs.
51
+
52
+
## Outputs
53
+
54
+
| Name | Description |
55
+
|------|-------------|
56
+
| <aname="output_db_shard_group_arn"></a> [db\_shard\_group\_arn](#output\_db\_shard\_group\_arn)| ARN of the shard group |
57
+
| <aname="output_db_shard_group_endpoint"></a> [db\_shard\_group\_endpoint](#output\_db\_shard\_group\_endpoint)| The connection endpoint for the DB shard group |
58
+
| <aname="output_db_shard_group_resource_id"></a> [db\_shard\_group\_resource\_id](#output\_db\_shard\_group\_resource\_id)| The AWS Region-unique, immutable identifier for the DB shard group |
0 commit comments