| Version | Link | Date |
|---|---|---|
| 6.3.0 | https://github.com/terraform-aws-modules/terraform-aws-rds | 22/01/2024 |
The following providers are used by this module:
- aws (>= 5.25)
The following Modules are called:
Source: ./modules/db_instance
Version:
Source: ./modules/db_instance_role_association
Version:
Source: ./modules/db_option_group
Version:
Source: ./modules/db_parameter_group
Version:
Source: ./modules/db_subnet_group
Version:
The following resources are used by this module:
- aws_caller_identity.current (data source)
The following input variables are required:
Description: The name of the RDS instance
Type: string
The following input variables are optional (have default values):
Description: The allocated storage in gigabytes
Type: number
Default: null
Description: 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
Type: bool
Default: false
Description: Specifies whether any database modifications are applied immediately, or during the next maintenance window
Type: bool
Default: false
Description: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window
Type: bool
Default: true
Description: The Availability Zone of the RDS instance
Type: string
Default: null
Description: The days to retain backups for
Type: number
Default: 30
Description: 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
Type: string
Default: null
Description: Enables low-downtime updates using RDS Blue/Green deployments.
Type: map(string)
Default: {}
Description: Specifies the identifier of the CA certificate for the DB instance
Type: string
Default: null
Description: 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
Type: string
Default: null
Description: The ARN of the KMS Key to use when encrypting log data
Type: string
Default: null
Description: The number of days to retain CloudWatch logs for the DB instance
Type: number
Default: 365
Description: On delete, copy all Instance tags to the final snapshot
Type: bool
Default: true
Description: Determines whether a CloudWatch log group is created for each enabled_cloudwatch_logs_exports
Type: bool
Default: false
Description: Whether to create a database instance
Type: bool
Default: true
Description: Create a database option group
Type: bool
Default: true
Description: Whether to create a database parameter group
Type: bool
Default: true
Description: Whether to create a database subnet group
Type: bool
Default: false
Description: Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs
Type: bool
Default: false
Description: RDS custom iam instance profile
Type: string
Default: null
Description: A map of DB instance supported feature name to role association ARNs.
Type: map(any)
Default: {}
Description: Additional tags for the DB instance
Type: map(string)
Default: {}
Description: The DB name to create. If omitted, no database is created initially
Type: string
Default: null
Description: Additional tags for the DB option group
Type: map(string)
Default: {}
Description: Additional tags for the DB parameter group
Type: map(string)
Default: {}
Description: Description of the DB subnet group to create
Type: string
Default: null
Description: 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
Type: string
Default: null
Description: Additional tags for the DB subnet group
Type: map(string)
Default: {}
Description: Determines whether to use subnet_group_name as is or create a unique name beginning with the subnet_group_name as the prefix
Type: bool
Default: true
Description: Specifies whether to remove automated backups immediately after the DB instance is deleted
Type: bool
Default: true
Description: The database can't be deleted when this value is set to true
Type: bool
Default: true
Description: The ID of the Directory Service Active Directory domain to create the instance in
Type: string
Default: null
Description: (Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service
Type: string
Default: null
Description: 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)
Type: list(string)
Default:
[
"general",
"error",
"slowquery"
]Description: The database engine to use
Type: string
Default: null
Description: The engine version to use
Type: string
Default: null
Description: The family of the DB parameter group
Type: string
Default: null
Description: The name which is prefixed to the final snapshot on cluster destroy
Type: string
Default: "final"
Description: Specifies whether or not the mappings of AWS Identity and Access Management (IAM) accounts to database accounts are enabled
Type: bool
Default: false
Description: The instance type of the RDS instance
Type: string
Default: null
Description: Determines whether to use identifier as is or create a unique identifier beginning with identifier as the specified prefix
Type: bool
Default: false
Description: The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' or gp3. See notes for limitations regarding this variable for gp3
Type: number
Default: null
Description: 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. Be sure to use the full ARN, not a key alias.
Type: string
Default: null
Description: License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1
Type: string
Default: null
Description: The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00'
Type: string
Default: null
Description: Specifies the major version of the engine that this option group should be associated with
Type: string
Default: null
Description: Set to true to allow RDS to manage the master user password in Secrets Manager
Type: bool
Default: true
Description: The key ARN, key ID, alias ARN or alias name for the KMS key to encrypt the master user password secret in Secrets Manager.
If not specified, the default KMS key for your Amazon Web Services account is used.
Type: string
Default: null
Description: Specifies the value for Storage Autoscaling
Type: number
Default: 0
Description: 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
Type: number
Default: 5
Description: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero
Type: string
Default: null
Description: Description of the monitoring IAM role
Type: string
Default: null
Description: Name of the IAM role which will be created when create_monitoring_role is enabled
Type: string
Default: "rds-monitoring-role"
Description: ARN of the policy that is used to set the permissions boundary for the monitoring IAM role
Type: string
Default: null
Description: Determines whether to use monitoring_role_name as is or create a unique identifier beginning with monitoring_role_name as the specified prefix
Type: bool
Default: false
Description: Specifies if the RDS instance is multi-AZ
Type: bool
Default: true
Description: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed.
Type: string
Default: null
Description: The type of network stack to use
Type: string
Default: null
Description: The description of the option group
Type: string
Default: null
Description: Name of the option group
Type: string
Default: null
Description: Define maximum timeout for deletion of aws_db_option_group resource
Type: map(string)
Default: {}
Description: Determines whether to use option_group_name as is or create a unique name beginning with the option_group_name as the prefix
Type: bool
Default: true
Description: A list of Options to apply
Type: any
Default: []
Description: Description of the DB parameter group to create
Type: string
Default: null
Description: Name of the DB parameter group to associate or create
Type: string
Default: null
Description: Determines whether to use parameter_group_name as is or create a unique name beginning with the parameter_group_name as the prefix
Type: bool
Default: true
Description: A list of DB parameters (map) to apply
Type: list(map(string))
Default: []
Description: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
The password provided will not be used if manage_master_user_password is set to true.
Type: string
Default: null
Description: Specifies whether Performance Insights are enabled
Type: bool
Default: true
Description: The ARN for the KMS key to encrypt Performance Insights data
Type: string
Default: null
Description: The amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31
Type: number
Default: 7
Description: The port on which the DB accepts connections
Type: string
Default: null
Description: Bool to control if instance is publicly accessible
Type: bool
Default: false
Description: Do you agree that Putin doesn't respect Ukrainian sovereignty and territorial integrity? More info: https://en.wikipedia.org/wiki/Putin_khuylo!
Type: bool
Default: true
Description: 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
Type: string
Default: null
Description: 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
Type: string
Default: null
Description: Restore to a point in time (MySQL is NOT supported)
Type: map(string)
Default: null
Description: Restore from a Percona Xtrabackup in S3 (only MySQL is supported)
Type: map(string)
Default: null
Description: 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
Type: bool
Default: false
Description: 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
Type: string
Default: null
Description: Specifies whether the DB instance is encrypted
Type: bool
Default: true
Description: Storage throughput value for the DB instance. See notes for limitations regarding this variable for gp3
Type: number
Default: null
Description: 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
Type: string
Default: null
Description: A list of VPC subnet IDs
Type: list(string)
Default: []
Description: A mapping of tags to assign to all resources
Type: map(string)
Default: {}
Description: Updated Terraform resource management timeouts. Applies to aws_db_instance in particular to permit resource management times
Type: map(string)
Default: {}
Description: 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
Type: string
Default: null
Description: Username for the master DB user
Type: string
Default: null
Description: List of VPC security groups to associate
Type: list(string)
Default: []
The following outputs are exported:
Description: AWS Account ID
Description: The address of the RDS instance
Description: The ARN of the RDS instance
Description: The availability zone of the RDS instance
Description: Specifies the identifier of the CA certificate for the DB instance
Description: Map of CloudWatch log groups created and their attributes
Description: The ID of the Directory Service Active Directory domain the instance is joined to
Description: The name of the IAM role to be used when making API calls to the Directory Service
Description: The connection endpoint
Description: The database engine
Description: The running version of the database
Description: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record)
Description: The RDS instance identifier
Description: The ARN of the master user secret (Only available when manage_master_user_password is set to true)
Description: The database name
Description: The database port
Description: The RDS Resource ID of this instance
Description: A map of DB Instance Identifiers and IAM Role ARNs separated by a comma
Description: The RDS instance status
Description: The master username for the database
Description: Specifies the listener connection endpoint for SQL Server Always On
Description: The ARN of the db option group
Description: The db option group id
Description: The ARN of the db parameter group
Description: The db parameter group id
Description: The ARN of the db subnet group
Description: The db subnet group name
Description: The Amazon Resource Name (ARN) specifying the monitoring role
Description: The name of the monitoring role
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent