Skip to content

Latest commit

 

History

History
85 lines (74 loc) · 8.72 KB

MODULE.md

File metadata and controls

85 lines (74 loc) · 8.72 KB

Requirements

Name Version
terraform >= 1.0
aws >= 5.0.0

Providers

Name Version
aws >= 5.0.0

Modules

Name Source Version
db terraform-aws-modules/rds/aws 6.1.1

Resources

Name Type
aws_ssm_parameter.address resource
aws_ssm_parameter.master_user_secret_arn resource
aws_ssm_parameter.name resource
aws_ssm_parameter.port resource

Inputs

Name Description Type Default Required
allocated_storage Storage size in GB. number null no
db_backup_retention_period Backup retention period in days. string "1" no
db_backup_window Preferred backup window. string "03:00-06:00" no
db_engine The name of the database engine to be used for RDS. string "postgres" no
db_engine_version The database engine version. string "16.3" no
db_family The family of the database engine to be used for RDS. string "postgres16" no
db_instance_class The instance class to use for RDS. string "db.t4g.small" no
db_maintenance_window Preferred maintenance window. string "Mon:00:00-Mon:03:00" no
db_major_engine_version The major engine version. string "16" no
db_master_password Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Required unless manage_master_user_password is set to true or 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
db_master_username Database username string "name" no
db_name Database name string "name" no
db_port Database port number 5432 no
db_storage_type Storage Type for RDS. string null no
db_subnet_group Database subnet group to use. Leave blank to create a new one. string "" no
enable_multi_az Create RDS instance in multiple availability zones. bool false no
enable_public_access Enable public access for RDS. bool true no
enable_skip_final_snapshot When DB is deleted and If this variable is false, no final snapshot will be made. bool true no
manage_master_user_password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided bool true no
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
max_allocated_storage Maximum storage size in GB. number null no
name Name to be used on all the resources as identifier string "" no
storage_encrypted Enable storage encryption. bool true no
tags Any extra tags to assign to objects map(any) {} no
vpc_id VPC id in which the RDS instance is to be created. string n/a yes
vpc_security_group_ids List of VPC security groups to associate with the RDS cluster list(string) [] no

Outputs

Name Description
db_instance_address The address of the RDS instance
db_instance_arn The ARN of the RDS instance
db_instance_availability_zone The availability zone of the RDS instance
db_instance_cloudwatch_log_groups Map of CloudWatch log groups created and their attributes
db_instance_endpoint The connection endpoint
db_instance_engine The database engine
db_instance_engine_version_actual The running version of the database
db_instance_hosted_zone_id The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record)
db_instance_identifier The RDS instance ID
db_instance_master_user_secret_arn The ARN of the AWS Secrets Manager secret created
db_instance_name The database name
db_instance_port The database port
db_instance_resource_id The RDS Resource ID of this instance
db_instance_status The RDS instance status
db_instance_username The master username for the database
db_parameter_group_arn The ARN of the db parameter group
db_parameter_group_id The db parameter group id
db_subnet_group_arn The ARN of the db subnet group
db_subnet_group_id The db subnet group name
enhanced_monitoring_iam_role_arn The Amazon Resource Name (ARN) specifying the monitoring role