github.com/arvindram03/terraform@v0.3.7-0.20150212015210-408f838db36d/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  	security_group_names = ["${aws_db_security_group.bar.name}"]
    26  	db_subnet_group_name = "my_database_subnet_group"
    27  	parameter_group_name = "default.mysql5.6"
    28  }
    29  ```
    30  
    31  ## Argument Reference
    32  
    33  The following arguments are supported:
    34  
    35  * `allocated_storage` - (Required) The allocated storage in gigabytes.
    36  * `engine` - (Required) The database engine to use.
    37  * `engine_version` - (Required) The engine version to use.
    38  * `identifier` - (Required) The name of the RDS instance
    39  * `instance_class` - (Required) The instance type of the RDS instance.
    40  * `final_snapshot_identifier` - (Optional) The name of your final DB snapshot
    41      when this DB instance is deleted. If omitted, no final snapshot will be
    42      made.
    43  * `name` - (Optional) The DB name to create. If omitted, no database is created
    44      initially.
    45  * `password` - (Required) Password for the master DB user. Note that this may
    46      show up in logs, and it will be stored in the state file.
    47  * `username` - (Required) Username for the master DB user.
    48  * `availability_zone` - (Optional) The AZ for the RDS instance.
    49  * `backup_retention_period` - (Optional) The days to retain backups for.
    50  * `backup_window` - (Optional) The backup window.
    51  * `iops` - (Optional) The amount of provisioned IOPS
    52  * `maintenance_window` - (Optional) The window to perform maintenance in.
    53  * `multi_az` - (Optional) Specifies if the RDS instance is multi-AZ
    54  * `port` - (Optional) The port on which the DB accepts connections.
    55  * `publicly_accessible` - (Optional) Bool to control if instance is publicly accessible.
    56  * `vpc_security_group_ids` - (Optional) List of VPC security groups to associate.
    57  * `security_group_names` - (Optional) List of DB Security Groups to associate.
    58  * `db_subnet_group_name` - (Optional) Name of DB subnet group
    59  * `parameter_group_name` - (Optional) Name of the DB parameter group to associate.
    60  
    61  ## Attributes Reference
    62  
    63  The following attributes are exported:
    64  
    65  * `id` - The RDS instance ID.
    66  * `address` - The address of the RDS instance.
    67  * `allocated_storage` - The amount of allocated storage
    68  * `availability_zone` - The availability zone of the instance
    69  * `backup_retention_period` - The backup retention period
    70  * `backup_window` - The backup window
    71  * `endpoint` - The connection endpoint
    72  * `engine` - The database engine
    73  * `engine_version` - The database engine version
    74  * `instance_class`- The RDS instance class
    75  * `maintenance_window` - The instance maintenance window
    76  * `multi_az` - If the RDS instance is multi AZ enabled
    77  * `name` - The database name
    78  * `port` - The database port
    79  * `status` - The RDS instance status
    80  * `username` - The master username for the database
    81