Name | Version |
---|---|
terraform | >= 1.3 |
aws | >= 4.12.0 |
Name | Version |
---|---|
aws | >= 4.12.0 |
Name | Description | Type | Default | Required |
---|---|---|---|---|
password | Password for the master DB user | string |
n/a | yes |
stack | The stack name for the Aurora Cluster | string |
n/a | yes |
subnet_ids | List of subnet IDs to deploy Aurora in | list(string) |
n/a | yes |
tags | A mapping of tags to assign to the bucket | map(string) |
n/a | yes |
username | Username for the master DB user | string |
n/a | yes |
apply_immediately | Specifies whether any cluster modifications are applied immediately | bool |
true |
no |
auto_pause | Whether to enable automatic pause | bool |
true |
no |
availability_zones | List of availability zones to deploy Aurora in | list(string) |
[] |
no |
backup_retention_period | The days to retain backups for | number |
7 |
no |
cidr_blocks | List of CIDR blocks that should be allowed access to the Aurora cluster | list(string) |
null |
no |
cluster_family | The family of the DB cluster parameter group | string |
"aurora-mysql5.7" |
no |
cluster_parameters | A list of cluster DB parameters to apply | list(object({ |
[ |
no |
database | The name of the first database to be created when the cluster is created | string |
null |
no |
database_parameters | A list of instance DB parameters to apply | list(object({ |
null |
no |
deletion_protection | A boolean indicating if the DB instance should have deletion protection enable | bool |
true |
no |
enable_http_endpoint | Enable Aurora Serverless HTTP endpoint (Data API) | bool |
false |
no |
enabled_cloudwatch_logs_exports | List of log types to export to cloudwatch | list(string) |
null |
no |
engine | The engine type of the Aurora cluster | string |
"aurora-mysql" |
no |
engine_mode | The engine mode of the Aurora cluster | string |
"serverless" |
no |
engine_version | The engine version of the Aurora cluster | string |
"5.7.mysql_aurora.2.08.3" |
no |
final_snapshot_identifier | Identifier of the final snapshot to create before deleting the cluster | string |
null |
no |
iam_database_authentication_enabled | Specify if mapping AWS IAM accounts to database accounts is enabled. | bool |
null |
no |
iam_roles | A list of IAM Role ARNs to associate with the cluster | list(string) |
null |
no |
instance_class | The class of RDS instances to attach. Only for serverless engine_mode | string |
"db.r5.large" |
no |
instance_count | The number of RDS instances to attach. Only for serverless engine_mode | number |
1 |
no |
kms_key_id | The KMS key ID used for the storage encryption | string |
null |
no |
max_capacity | The maximum capacity of the serverless cluster | string |
8 |
no |
min_capacity | The minimum capacity of the serverless cluster | string |
1 |
no |
monitoring_interval | The interval (seconds) for collecting enhanced monitoring metrics | string |
null |
no |
performance_insights | Specifies whether Performance Insights is enabled or not | bool |
false |
no |
performance_insights_retention_period | Amount of time in days to retain Performance Insights data. Valida values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights needs to be set to true | number |
7 |
no |
permissions_boundary | The ARN of the policy that is used to set the permissions boundary for the role | string |
null |
no |
preferred_backup_window | The daily time range during which automated backups are created, in UTC e.g. 04:00-09:00 | string |
null |
no |
preferred_maintenance_window | The weekly time range during which system maintenance can occur, in UTC e.g. wed:04:00-wed:04:30 | string |
null |
no |
publicly_accessible | Control if instances in cluster are publicly accessible | string |
false |
no |
security_group_ids | List of security group IDs allowed to connect to Aurora | list(string) |
[] |
no |
skip_final_snapshot | Determines whether a final snapshot is created before deleting the cluster | bool |
false |
no |
snapshot_identifier | Database snapshot identifier to create the database from | string |
null |
no |
storage_encrypted | Specifies whether the DB cluster is encrypted | bool |
true |
no |
Name | Description |
---|---|
arn | ARN of the Aurora cluster |
cluster_identifier | The RDS Cluster Identifier |
cluster_resource_id | The RDS Cluster Resource ID |
database | Name of the first database created when the cluster was created |
endpoint | DNS address of the RDS instance |
id | ID of the Aurora cluster |
instance_ids | ID's of RDS Aurora instances |
port | Port on which the DB accepts connections |
reader_endpoint | A load-balanced read-only endpoint for the Aurora cluster |
security_group_id | The securitiry group id that is attached to the Aurora cluster |
username | Username for the master DB user |