| alias |
The display name of the alias. The name must start with the word alias followed by a forward slash. |
string |
"alias/rds" |
no |
| allocated_storage |
The allocated storage in gigabytes |
string |
null |
no |
| allow_major_version_upgrade |
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible |
bool |
false |
no |
| allowed_ip |
List of allowed ip. |
list(any) |
[] |
no |
| allowed_ports |
List of allowed ingress ports |
list(any) |
[] |
no |
| apply_immediately |
Specifies whether any database modifications are applied immediately, or during the next maintenance window |
bool |
false |
no |
| auto_minor_version_upgrade |
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window |
bool |
true |
no |
| availability_zone |
The Availability Zone of the RDS instance |
string |
null |
no |
| backup_retention_period |
The days to retain backups for |
number |
null |
no |
| backup_window |
The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window |
string |
null |
no |
| blue_green_update |
Enables low-downtime updates using RDS Blue/Green deployments. |
map(string) |
{} |
no |
| ca_cert_identifier |
Specifies the identifier of the CA certificate for the DB instance |
string |
null |
no |
| character_set_name |
The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS and Collations and Character Sets for Microsoft SQL Server for more information. This can only be set on creation. |
string |
null |
no |
| cloudwatch_log_group_retention_in_days |
The number of days to retain CloudWatch logs for the DB instance |
number |
7 |
no |
| cloudwatch_log_group_tags |
Additional tags for the cloudwatch log group |
map(any) |
{} |
no |
| copy_tags_to_snapshot |
On delete, copy all Instance tags to the final snapshot |
bool |
true |
no |
| custom_iam_instance_profile |
RDS custom iam instance profile |
string |
null |
no |
| customer_master_key_spec |
Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: SYMMETRIC_DEFAULT, RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, or ECC_SECG_P256K1. Defaults to SYMMETRIC_DEFAULT. |
string |
"SYMMETRIC_DEFAULT" |
no |
| db_instance_read_tags |
Additional tags for the DB instance |
map(any) |
{} |
no |
| db_instance_this_tags |
Additional tags for the DB instance |
map(any) |
{} |
no |
| db_name |
The DB name to create. If omitted, no database is created initially |
string |
null |
no |
| db_option_group_tags |
Additional tags for the DB option group |
map(any) |
{} |
no |
| db_parameter_group_tags |
Additional tags for the DB parameter group |
map(any) |
{} |
no |
| db_subnet_group_name |
Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC |
string |
"" |
no |
| db_subnet_group_tags |
Additional tags for the DB subnet group |
map(any) |
{} |
no |
| delete_automated_backups |
Specifies whether to remove automated backups immediately after the DB instance is deleted |
bool |
true |
no |
| deletion_protection |
The database can't be deleted when this value is set to true. |
bool |
true |
no |
| deletion_window_in_days |
Duration in days after which the key is deleted after destruction of the resource. |
number |
7 |
no |
| delimiter |
Delimiter to be used between organization, environment, name and attributes. |
string |
"-" |
no |
| domain |
The ID of the Directory Service Active Directory domain to create the instance in |
string |
null |
no |
| domain_iam_role_name |
(Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service |
string |
null |
no |
| egress_rule |
Enable to create egress rule |
bool |
true |
no |
| enable_key_rotation |
Specifies whether key rotation is enabled. |
string |
true |
no |
| enable_security_group |
Enable default Security Group with only Egress traffic allowed. |
bool |
true |
no |
| enabled |
Whether to create this resource or not? |
bool |
true |
no |
| enabled_cloudwatch_log_group |
Determines whether a CloudWatch log group is created for each enabled_cloudwatch_logs_exports |
bool |
false |
no |
| enabled_cloudwatch_logs_exports |
List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). |
list(string) |
[] |
no |
| enabled_db_subnet_group |
A list of enabled db subnet group |
bool |
true |
no |
| enabled_monitoring_role |
Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. |
bool |
false |
no |
| enabled_read_replica |
A list of enabled read replica |
bool |
true |
no |
| enabled_replica |
A list of enabled replica |
bool |
false |
no |
| engine |
The database engine to use |
string |
"mysql" |
no |
| engine_name |
Specifies the name of the engine that this option group should be associated with |
string |
"mysql" |
no |
| engine_version |
The engine version to use |
string |
null |
no |
| environment |
Environment (e.g. prod, dev, staging). |
string |
"" |
no |
| family |
The family of the DB parameter group |
string |
null |
no |
| iam_database_authentication_enabled |
Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled |
bool |
true |
no |
| identifier |
The name of the RDS instance |
string |
"" |
no |
| instance_class |
The instance type of the RDS instance |
string |
null |
no |
| iops |
The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' or gp3. See notes for limitations regarding this variable for gp3 |
number |
null |
no |
| is_enabled |
Specifies whether the key is enabled. |
bool |
true |
no |
| is_external |
enable to udated existing security Group |
bool |
false |
no |
| key_usage |
Specifies the intended use of the key. Defaults to ENCRYPT_DECRYPT, and only symmetric encryption and decryption are supported. |
string |
"ENCRYPT_DECRYPT" |
no |
| kms_description |
The description of the key as viewed in AWS console. |
string |
"Parameter Store KMS master key" |
no |
| kms_key_enabled |
Specifies whether the kms is enabled or disabled. |
bool |
true |
no |
| kms_key_id |
The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used |
string |
"" |
no |
| kms_multi_region |
Indicates whether the KMS key is a multi-Region (true) or regional (false) key. |
bool |
false |
no |
| label_order |
Label order, e.g. name,application. |
list(any) |
[] |
no |
| license_model |
License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 |
string |
null |
no |
| maintenance_window |
The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' |
string |
null |
no |
| major_engine_version |
Specifies the major version of the engine that this option group should be associated with |
string |
null |
no |
| managedby |
ManagedBy, eg 'pps'. |
string |
"ctr.anmol.nagpal@prth.com" |
no |
| max_allocated_storage |
Specifies the value for Storage Autoscaling |
number |
0 |
no |
| monitoring_interval |
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. |
number |
0 |
no |
| monitoring_role_description |
Description of the monitoring IAM role |
string |
null |
no |
| monitoring_role_name |
Name of the IAM role which will be created when create_monitoring_role is enabled. |
string |
"rds-monitoring-role" |
no |
| monitoring_role_permissions_boundary |
ARN of the policy that is used to set the permissions boundary for the monitoring IAM role |
string |
null |
no |
| multi_az |
Specifies if the RDS instance is multi-AZ |
bool |
false |
no |
| mysql_iam_role_tags |
Additional tags for the mysql iam role |
map(any) |
{} |
no |
| name |
Name (e.g. app or cluster). |
string |
"" |
no |
| network_type |
The type of network stack |
string |
null |
no |
| option_group_description |
The description of the option group |
string |
null |
no |
| options |
A list of Options to apply |
any |
[] |
no |
| parameters |
A list of DB parameter maps to apply |
list(map(string)) |
[] |
no |
| password |
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file |
string |
null |
no |
| performance_insights_enabled |
Specifies whether Performance Insights are enabled |
bool |
false |
no |
| performance_insights_kms_key_id |
The ARN for the KMS key to encrypt Performance Insights data. |
string |
null |
no |
| performance_insights_retention_period |
The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). |
number |
7 |
no |
| port |
The port on which the DB accepts connections |
string |
null |
no |
| protocol |
The protocol. If not icmp, tcp, udp, or all use the. |
string |
"tcp" |
no |
| publicly_accessible |
Bool to control if instance is publicly accessible |
bool |
false |
no |
| replica_instance_class |
The instance type of the RDS instance |
string |
"" |
no |
| replica_mode |
Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified |
string |
null |
no |
| replicate_source_db |
Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. |
string |
null |
no |
| restore_to_point_in_time |
Restore to a point in time (MySQL is NOT supported) |
map(string) |
null |
no |
| s3_import |
Restore from a Percona Xtrabackup in S3 (only MySQL is supported) |
map(string) |
null |
no |
| sg_description |
The security group description. |
string |
"Instance default security group (only egress access is allowed)." |
no |
| sg_egress_description |
Description of the egress and ingress rule |
string |
"Description of the rule." |
no |
| sg_egress_ipv6_description |
Description of the egress_ipv6 rule |
string |
"Description of the rule." |
no |
| sg_ids |
of the security group id. |
list(any) |
[] |
no |
| sg_ingress_description |
Description of the ingress rule |
string |
"Description of the ingress rule use elasticache." |
no |
| skip_final_snapshot |
Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted |
bool |
true |
no |
| snapshot_identifier |
Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. |
string |
"" |
no |
| ssm_parameter_description |
SSM Parameters can be imported using. |
string |
"Description of the parameter." |
no |
| ssm_parameter_endpoint_enabled |
Name of the parameter. |
bool |
false |
no |
| ssm_parameter_type |
Type of the parameter. |
string |
"SecureString" |
no |
| storage_encrypted |
Specifies whether the DB instance is encrypted |
bool |
true |
no |
| storage_throughput |
Storage throughput value for the DB instance. This setting applies only to the gp3 storage type. See notes for limitations regarding this variable for gp3 |
number |
null |
no |
| storage_type |
One of 'standard' (magnetic), 'gp2' (general purpose SSD), 'gp3' (new generation of general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'gp2' if not. If you specify 'io1' or 'gp3' , you must also include a value for the 'iops' parameter |
string |
null |
no |
| subnet_ids |
A list of VPC Subnet IDs to launch in. |
list(string) |
[] |
no |
| timeouts |
Define maximum timeout for deletion of aws_db_option_group resource |
map(string) |
{} |
no |
| timezone |
Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. |
string |
null |
no |
| use_identifier_prefix |
Determines whether to use identifier as is or create a unique identifier beginning with identifier as the specified prefix |
bool |
false |
no |
| username |
Username for the master DB user |
string |
null |
no |
| vpc_id |
The ID of the VPC that the instance security group belongs to. |
string |
"" |
no |