Provide RDS cluster instance endpoint connection resources, see What is RDS DB Instance Endpoint.

-> NOTE: Available since v1.203.0.

Example Usage

provider "alicloud" {
  region = "cn-beijing"
}

variable "name" {
  default = "tf-example"
}
data "alicloud_db_zones" "default" {
  engine                   = "MySQL"
  engine_version           = "8.0"
  instance_charge_type     = "PostPaid"
  category                 = "cluster"
  db_instance_storage_type = "cloud_essd"
}

data "alicloud_db_instance_classes" "default" {
  zone_id                  = data.alicloud_db_zones.default.ids.0
  engine                   = "MySQL"
  engine_version           = "8.0"
  category                 = "cluster"
  db_instance_storage_type = "cloud_essd"
  instance_charge_type     = "PostPaid"
}

resource "alicloud_vpc" "default" {
  vpc_name   = var.name
  cidr_block = "172.16.0.0/16"
}
resource "alicloud_vswitch" "default" {
  vpc_id       = alicloud_vpc.default.id
  cidr_block   = "172.16.0.0/24"
  zone_id      = data.alicloud_db_zones.default.ids.0
  vswitch_name = var.name
}

resource "alicloud_security_group" "default" {
  name   = var.name
  vpc_id = alicloud_vpc.default.id
}

resource "alicloud_db_instance" "default" {
  engine                   = "MySQL"
  engine_version           = "8.0"
  instance_type            = data.alicloud_db_instance_classes.default.instance_classes.0.instance_class
  instance_storage         = data.alicloud_db_instance_classes.default.instance_classes.0.storage_range.min
  instance_charge_type     = "Postpaid"
  instance_name            = var.name
  vswitch_id               = alicloud_vswitch.default.id
  monitoring_period        = "60"
  db_instance_storage_type = "cloud_essd"
  security_group_ids       = [alicloud_security_group.default.id]
  zone_id                  = data.alicloud_db_zones.default.ids.0
  zone_id_slave_a          = data.alicloud_db_zones.default.ids.0
}

resource "alicloud_rds_db_node" "default" {
  db_instance_id = alicloud_db_instance.default.id
  class_code     = alicloud_db_instance.default.instance_type
  zone_id        = alicloud_vswitch.default.zone_id
}

resource "alicloud_rds_db_instance_endpoint" "default" {
  db_instance_id                   = alicloud_rds_db_node.default.db_instance_id
  vpc_id                           = alicloud_vpc.default.id
  vswitch_id                       = alicloud_db_instance.default.vswitch_id
  connection_string_prefix         = "example"
  port                             = "3306"
  db_instance_endpoint_description = var.name
  node_items {
    node_id = alicloud_rds_db_node.default.node_id
    weight  = 25
  }
}

Argument Reference

The following arguments are supported:

• db_instance_id - (Required, ForceNew) The ID of the instance.
• vpc_id - (Required) The virtual private cloud (VPC) ID of the internal endpoint.
• vswitch_id - (Required) The vSwitch ID of the internal endpoint.
• connection_string_prefix - (Required) The IP address of the internal endpoint.
• port - (Required) The port number of the internal endpoint. You can specify the port number for the internal endpoint.Valid values: 3000 to 5999.
• db_instance_endpoint_description - (Optional) The user-defined description of the endpoint.
• node_items - (Required) The information about the node that is configured for the endpoint. It contains two sub-fields(node_id and weight). See node_items below.

node_items

The node_items mapping supports the following:

• node_id - (Required) The ID of the node.
• weight - (Required) The weight of the node. Read requests are distributed based on the weight.Valid values: 0 to 100.

Attributes Reference

The following attributes are exported:

• id - The resource ID in terraform of endpoint.The value formats as <db_instance_id>:<db_instance_endpoint_id>.
• private_ip_address - The IP address of the internal endpoint.
• connection_string - The internal endpoint.
• db_instance_endpoint_type - The type of the endpoint.
• ip_type - The type of the IP address.
• db_instance_endpoint_id - The Endpoint ID of the instance.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

• create - (Defaults to 30 mins) Use when opening exclusive agent (until it reaches the initial Running status).
• update - (Defaults to 30 mins) Used when updating exclusive agent (until it reaches the initial Running status).
• delete - (Defaults to 20 mins) Use when closing exclusive agent.

Import

RDS database endpoint feature can be imported using the id, e.g.

$ terraform import alicloud_rds_db_instance_endpoint.example <db_instance_id>:<db_instance_endpoint_id>