github.com/jsoriano/terraform@v0.6.7-0.20151026070445-8b70867fdd95/website/source/docs/providers/aws/r/rds_cluster.html.markdown (about) 1 --- 2 layout: "aws" 3 page_title: "AWS: aws_rds_cluster" 4 sidebar_current: "docs-aws-resource-rds-cluster" 5 description: |- 6 Provides an RDS Cluster Resource 7 --- 8 9 # aws\_rds\_cluster 10 11 Provides an RDS Cluster Resource. A Cluster Resource defines attributes that are 12 applied to the entire cluster of [RDS Cluster Instances][3]. Use the RDS Cluster 13 resource and RDS Cluster Instances to create and use Amazon Aurora, a MySQL-compatible 14 database engine. 15 16 For more information on Amazon Aurora, see [Aurora on Amazon RDS][2] in the Amazon RDS User Guide. 17 18 ## Example Usage 19 20 ``` 21 resource "aws_rds_cluster" "default" { 22 cluster_identifier = "aurora-cluster-demo" 23 availability_zones = ["us-west-2a","us-west-2b","us-west-2c"] 24 database_name = "mydb" 25 master_username = "foo" 26 master_password = "bar" 27 } 28 ``` 29 30 ~> **NOTE:** RDS Clusters resources that are created without any matching 31 RDS Cluster Instances do not currently display in the AWS Console. 32 33 ## Argument Reference 34 35 For more detailed documentation about each argument, refer to 36 the [AWS official documentation](http://docs.aws.amazon.com/AmazonRDS/latest/CommandLineReference/CLIReference-cmd-ModifyDBInstance.html). 37 38 The following arguments are supported: 39 40 * `cluster_identifier` - (Required) The Cluster Identifier. Must be a lower case 41 string. 42 * `database_name` - (Optional) The name for your database of up to 8 alpha-numeric 43 characters. If you do not provide a name, Amazon RDS will not create a 44 database in the DB cluster you are creating 45 * `master_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 * `master_username` - (Required) Username for the master DB user 48 * `final_snapshot_identifier` - (Optional) The name of your final DB snapshot 49 when this DB cluster is deleted. If omitted, no final snapshot will be 50 made. 51 * `availability_zones` - (Optional) A list of EC2 Availability Zones that 52 instances in the DB cluster can be created in 53 * `backup_retention_period` - (Optional) The days to retain backups for. Default 54 1 55 * `port` - (Optional) The port on which the DB accepts connections 56 * `vpc_security_group_ids` - (Optional) List of VPC security groups to associate 57 with the Cluster 58 * `apply_immediately` - (Optional) Specifies whether any cluster modifications 59 are applied immediately, or during the next maintenance window. Default is 60 `false`. See [Amazon RDS Documentation for more information.](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) 61 62 ## Attributes Reference 63 64 The following attributes are exported: 65 66 * `id` - The RDS Cluster Identifier 67 * `cluster_identifier` - The RDS Cluster Identifier 68 * `cluster_members` – List of RDS Instances that are a part of this cluster 69 * `address` - The address of the RDS instance. 70 * `allocated_storage` - The amount of allocated storage 71 * `availability_zones` - The availability zone of the instance 72 * `backup_retention_period` - The backup retention period 73 * `backup_window` - The backup window 74 * `endpoint` - The primary, writeable connection endpoint 75 * `engine` - The database engine 76 * `engine_version` - The database engine version 77 * `maintenance_window` - The instance maintenance window 78 * `database_name` - The database name 79 * `port` - The database port 80 * `status` - The RDS instance status 81 * `username` - The master username for the database 82 * `storage_encrypted` - Specifies whether the DB instance is encrypted 83 84 [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html 85 86 [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html 87 [3]: /docs/providers/aws/r/rds_cluster_instance.html