4.6 KiB
4.6 KiB
layout | page_title | sidebar_current | description |
---|---|---|---|
aws | AWS: aws_db_instance | docs-aws-resource-db-instance | Provides an RDS instance resource. |
aws_db_instance
Provides an RDS instance resource.
Example Usage
resource "aws_db_instance" "default" {
identifier = "mydb-rds"
allocated_storage = 10
engine = "mysql"
engine_version = "5.6.17"
instance_class = "db.t1.micro"
name = "mydb"
username = "foo"
password = "bar"
db_subnet_group_name = "my_database_subnet_group"
parameter_group_name = "default.mysql5.6"
}
Argument Reference
The following arguments are supported:
allocated_storage
- (Required) The allocated storage in gigabytes.engine
- (Required) The database engine to use.engine_version
- (Required) The engine version to use.identifier
- (Required) The name of the RDS instanceinstance_class
- (Required) The instance type of the RDS instance.storage_type
- (Optional) One of "standard" (magnetic), "gp2" (general purpose SSD), or "io1" (provisioned IOPS SSD). The default is "io1" ifiops
is specified, "standard" if not.final_snapshot_identifier
- (Optional) The name of your final DB snapshot when this DB instance is deleted. If omitted, no final snapshot will be made.name
- (Optional) The DB name to create. If omitted, no database is created initially.password
- (Required) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.username
- (Required) Username for the master DB user.availability_zone
- (Optional) The AZ for the RDS instance.backup_retention_period
- (Optional) The days to retain backups for. Must be1
or greater to be a source for a Read Replica.backup_window
- (Optional) The backup window.iops
- (Optional) The amount of provisioned IOPS. Setting this implies a storage_type of "io1".maintenance_window
- (Optional) The window to perform maintenance in.multi_az
- (Optional) Specifies if the RDS instance is multi-AZport
- (Optional) The port on which the DB accepts connections.publicly_accessible
- (Optional) Bool to control if instance is publicly accessible.vpc_security_group_ids
- (Optional) List of VPC security groups to associate.security_group_names
- (Optional/Deprecated) List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.db_subnet_group_name
- (Optional) Name of DB subnet groupparameter_group_name
- (Optional) Name of the DB parameter group to associate.storage_encrypted
- (Optional) Specifies whether the DB instance is encrypted. The default isfalse
if not specified.apply_immediately
- (Optional) Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse
. See Amazon RDS Documentation for more for more information.replicate_source
- (Optional) Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to theidentifier
of another Amazon RDS Database to replicate. See DB Instance Replication and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
~> NOTE: Removing the replicate_source
attribute from an existing RDS
Replicate database managed by Terraform will promote the database to a fully
standalone database.
Attributes Reference
The following attributes are exported:
id
- The RDS instance ID.address
- The address of the RDS instance.allocated_storage
- The amount of allocated storageavailability_zone
- The availability zone of the instancebackup_retention_period
- The backup retention periodbackup_window
- The backup windowendpoint
- The connection endpointengine
- The database engineengine_version
- The database engine versioninstance_class
- The RDS instance classmaintenance_window
- The instance maintenance windowmulti_az
- If the RDS instance is multi AZ enabledname
- The database nameport
- The database portstatus
- The RDS instance statususername
- The master username for the databasestorage_encrypted
- Specifies whether the DB instance is encrypted