github.com/hobbeswalsh/terraform@v0.3.7-0.20150619183303-ad17cf55a0fa/website/source/docs/providers/aws/r/db_instance.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_db_instance"
     4  sidebar_current: "docs-aws-resource-db-instance"
     5  description: |-
     6    Provides an RDS instance resource.
     7  ---
     8  
     9  # aws\_db\_instance
    10  
    11  Provides an RDS instance resource.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "aws_db_instance" "default" {
    17  	identifier = "mydb-rds"
    18  	allocated_storage = 10
    19  	engine = "mysql"
    20  	engine_version = "5.6.17"
    21  	instance_class = "db.t1.micro"
    22  	name = "mydb"
    23  	username = "foo"
    24  	password = "bar"
    25  	db_subnet_group_name = "my_database_subnet_group"
    26  	parameter_group_name = "default.mysql5.6"
    27  }
    28  ```
    29  
    30  ## Argument Reference
    31  
    32  For more detailed documentation about each argument, refer to
    33  the [AWS official documentation](http://docs.aws.amazon.com/AmazonRDS/latest/CommandLineReference/CLIReference-cmd-ModifyDBInstance.html).
    34  
    35  The following arguments are supported:
    36  
    37  * `allocated_storage` - (Required) The allocated storage in gigabytes.
    38  * `engine` - (Required) The database engine to use.
    39  * `engine_version` - (Required) The engine version to use.
    40  * `identifier` - (Required) The name of the RDS instance
    41  * `instance_class` - (Required) The instance type of the RDS instance.
    42  * `storage_type` - (Optional) One of "standard" (magnetic), "gp2" (general
    43  	purpose SSD), or "io1" (provisioned IOPS SSD). The default is "io1" if
    44  	`iops` is specified, "standard" if not.
    45  * `final_snapshot_identifier` - (Optional) The name of your final DB snapshot
    46      when this DB instance is deleted. If omitted, no final snapshot will be
    47      made.
    48  * `name` - (Optional) The DB name to create. If omitted, no database is created
    49      initially.
    50  * `password` - (Required) Password for the master DB user. Note that this may
    51      show up in logs, and it will be stored in the state file.
    52  * `username` - (Required) Username for the master DB user.
    53  * `availability_zone` - (Optional) The AZ for the RDS instance.
    54  * `backup_retention_period` - (Optional) The days to retain backups for. Must be
    55  `1` or greater to be a source for a [Read Replica][1].
    56  * `backup_window` - (Optional) The backup window.
    57  * `iops` - (Optional) The amount of provisioned IOPS. Setting this implies a
    58      storage_type of "io1".
    59  * `maintenance_window` - (Optional) The window to perform maintenance in.
    60    Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
    61    See [RDS Maintenance Window docs](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) for more.
    62  * `multi_az` - (Optional) Specifies if the RDS instance is multi-AZ
    63  * `port` - (Optional) The port on which the DB accepts connections.
    64  * `publicly_accessible` - (Optional) Bool to control if instance is publicly accessible.
    65  * `vpc_security_group_ids` - (Optional) List of VPC security groups to associate.
    66  * `security_group_names` - (Optional/Deprecated) List of DB Security Groups to associate.
    67      Only used for [DB Instances on the _EC2-Classic_ Platform](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html#USER_VPC.FindDefaultVPC).
    68  * `db_subnet_group_name` - (Optional) Name of DB subnet group
    69  * `parameter_group_name` - (Optional) Name of the DB parameter group to associate.
    70  * `storage_encrypted` - (Optional) Specifies whether the DB instance is encrypted. The default is `false` if not specified.
    71  * `apply_immediately` - (Optional) Specifies whether any database modifications
    72       are applied immediately, or during the next maintenance window. Default is
    73       `false`. See [Amazon RDS Documentation for more information.](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
    74  * `replicate_source_db` - (Optional) Specifies that this resource is a Replicate
    75  database, and to use this value as the source database. This correlates to the
    76  `identifier` of another Amazon RDS Database to replicate. See
    77  [DB Instance Replication][1] and
    78  [Working with PostgreSQL and MySQL Read Replicas](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) for
    79   more information on using Replication.
    80  
    81  
    82  ~> **NOTE:** Removing the `replicate_source_db` attribute from an existing RDS
    83  Replicate database managed by Terraform will promote the database to a fully
    84  standalone database.
    85  
    86  ## Attributes Reference
    87  
    88  The following attributes are exported:
    89  
    90  * `id` - The RDS instance ID.
    91  * `address` - The address of the RDS instance.
    92  * `allocated_storage` - The amount of allocated storage
    93  * `availability_zone` - The availability zone of the instance
    94  * `backup_retention_period` - The backup retention period
    95  * `backup_window` - The backup window
    96  * `endpoint` - The connection endpoint
    97  * `engine` - The database engine
    98  * `engine_version` - The database engine version
    99  * `instance_class`- The RDS instance class
   100  * `maintenance_window` - The instance maintenance window
   101  * `multi_az` - If the RDS instance is multi AZ enabled
   102  * `name` - The database name
   103  * `port` - The database port
   104  * `status` - The RDS instance status
   105  * `username` - The master username for the database
   106  * `storage_encrypted` - Specifies whether the DB instance is encrypted
   107  
   108  [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html