github.com/jmbataller/terraform@v0.6.8-0.20151125192640-b7a12e3a580c/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 backup_retention_period = 5 28 preferred_backup_window = "07:00-09:00" 29 } 30 ``` 31 32 ~> **NOTE:** RDS Clusters resources that are created without any matching 33 RDS Cluster Instances do not currently display in the AWS Console. 34 35 ## Argument Reference 36 37 For more detailed documentation about each argument, refer to 38 the [AWS official documentation](http://docs.aws.amazon.com/AmazonRDS/latest/CommandLineReference/CLIReference-cmd-ModifyDBInstance.html). 39 40 The following arguments are supported: 41 42 * `cluster_identifier` - (Required) The Cluster Identifier. Must be a lower case 43 string. 44 * `database_name` - (Optional) The name for your database of up to 8 alpha-numeric 45 characters. If you do not provide a name, Amazon RDS will not create a 46 database in the DB cluster you are creating 47 * `master_password` - (Required) Password for the master DB user. Note that this may 48 show up in logs, and it will be stored in the state file 49 * `master_username` - (Required) Username for the master DB user 50 * `final_snapshot_identifier` - (Optional) The name of your final DB snapshot 51 when this DB cluster is deleted. If omitted, no final snapshot will be 52 made. 53 * `availability_zones` - (Optional) A list of EC2 Availability Zones that 54 instances in the DB cluster can be created in 55 * `backup_retention_period` - (Optional) The days to retain backups for. Default 56 1 57 * `preferred_backup_window` - (Optional) The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. 58 Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00 59 * `preferred_maintenance_window` - (Optional) The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30 60 * `port` - (Optional) The port on which the DB accepts connections 61 * `vpc_security_group_ids` - (Optional) List of VPC security groups to associate 62 with the Cluster 63 * `apply_immediately` - (Optional) Specifies whether any cluster modifications 64 are applied immediately, or during the next maintenance window. Default is 65 `false`. See [Amazon RDS Documentation for more information.](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) 66 * `db_subnet_group_name` - (Optional) A DB subnet group to associate with this DB instance. 67 68 ## Attributes Reference 69 70 The following attributes are exported: 71 72 * `id` - The RDS Cluster Identifier 73 * `cluster_identifier` - The RDS Cluster Identifier 74 * `cluster_members` – List of RDS Instances that are a part of this cluster 75 * `address` - The address of the RDS instance. 76 * `allocated_storage` - The amount of allocated storage 77 * `availability_zones` - The availability zone of the instance 78 * `backup_retention_period` - The backup retention period 79 * `preferred_backup_window` - The backup window 80 * `preferred_maintenance_window` - The maintenance window 81 * `endpoint` - The primary, writeable connection endpoint 82 * `engine` - The database engine 83 * `engine_version` - The database engine version 84 * `maintenance_window` - The instance maintenance window 85 * `database_name` - The database name 86 * `port` - The database port 87 * `status` - The RDS instance status 88 * `username` - The master username for the database 89 * `storage_encrypted` - Specifies whether the DB instance is encrypted 90 * `preferred_backup_window` - The daily time range during which the backups happen 91 92 [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html 93 94 [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html 95 [3]: /docs/providers/aws/r/rds_cluster_instance.html