opentf/website/source/docs/providers/aws/r/rds_cluster_instance.html.markdown

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
aws	AWS: aws_rds_cluster_instance	docs-aws-resource-rds-cluster-instance	Provides an RDS Cluster Resource Instance

aws_rds_cluster_instance

Provides an RDS Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a RDS Cluster, specifically running Amazon Aurora.

Unlike other RDS resources that support replication, with Amazon Aurora you do not designate a primary and subsequent replicas. Instead, you simply add RDS Instances and Aurora manages the replication. You can use the count meta-parameter to make multiple instances and join them all to the same RDS Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Example Usage

resource "aws_rds_cluster_instance" "cluster_instances" {
  count = 2
  identifier = "aurora-cluster-demo"
  cluster_identifier = "${aws_rds_cluster.default.id}"
  instance_class = "db.r3.large"
}

resource "aws_rds_cluster" "default" {
  cluster_identifier = "aurora-cluster-demo"
  availability_zones = ["us-west-2a","us-west-2b","us-west-2c"]
  database_name = "mydb"
  master_username = "foo"
  master_password = "bar"
}

Argument Reference

For more detailed documentation about each argument, refer to the AWS official documentation.

The following arguments are supported:

• identifier - (Optional) The Instance Identifier. Must be a lower case string. If omitted, a unique identifier will be generated.

• cluster_identifier - (Required) The Cluster Identifier for this Instance to join. Must be a lower case string.

• instance_class - (Required) The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora currently supports the below instance classes.

  • db.r3.large
  • db.r3.xlarge
  • db.r3.2xlarge
  • db.r3.4xlarge
  • db.r3.8xlarge

• publicly_accessible - (Optional) Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.

• db_subnet_group_name - (Optional) A DB subnet group to associate with this DB instance.

~> NOTE: db_subnet_group_name is a required field when you are trying to create a private instance (publicly_accessible = false)

Attributes Reference

The following attributes are exported:

• cluster_identifier - The RDS Cluster Identifier
• identifier - The Instance identifier
• id - The Instance identifier
• writer – Boolean indicating if this instance is writable. False indicates this instance is a read replica
• allocated_storage - The amount of allocated storage
• availability_zones - The availability zone of the instance
• endpoint - The IP address for this instance. May not be writable
• engine - The database engine
• engine_version - The database engine version
• database_name - The database name
• port - The database port
• status - The RDS instance status