» Resource: aws_docdb_cluster_instance

Provides an DocDB Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a DocDB Cluster.

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

» Example Usage

resource "aws_docdb_cluster_instance" "cluster_instances" {
  count              = 2
  identifier         = "docdb-cluster-demo-${count.index}"
  cluster_identifier = "${aws_docdb_cluster.default.id}"
  instance_class     = "db.r5.large"

resource "aws_docdb_cluster" "default" {
  cluster_identifier = "docdb-cluster-demo"
  availability_zones = ["us-west-2a", "us-west-2b", "us-west-2c"]
  master_username    = "foo"
  master_password    = "barbut8chars"

» Argument Reference

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

The following arguments are supported:

  • apply_immediately - (Optional) Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
  • auto_minor_version_upgrade - (Optional) Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
  • availability_zone - (Optional, Computed) The EC2 Availability Zone that the DB instance is created in. See docs about the details.
  • cluster_identifier - (Required) The identifier of the aws_docdb_cluster in which to launch this instance.
  • engine - (Optional) The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.
  • identifier - (Optional, Forces new resource) The indentifier for the DocDB instance, if omitted, Terraform will assign a random, unique identifier.
  • identifier_prefix - (Optional, Forces new resource) Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.
  • instance_class - (Required) The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details.
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
  • preferred_maintenance_window - (Optional) The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
  • promotion_tier - (Optional) Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
  • tags - (Optional) A map of tags to assign to the instance.

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - Amazon Resource Name (ARN) of cluster instance
  • db_subnet_group_name - The DB subnet group to associate with this DB instance.
  • dbi_resource_id - The region-unique, immutable identifier for the DB instance.
  • endpoint - The DNS address for this instance. May not be writable
  • engine_version - The database engine version
  • kms_key_id - The ARN for the KMS encryption key if one is set to the cluster.
  • port - The database port
  • preferred_backup_window - The daily time range during which automated backups are created if automated backups are enabled.
  • storage_encrypted - Specifies whether the DB cluster is encrypted.
  • writer – Boolean indicating if this instance is writable. False indicates this instance is a read replica.
  • ca_cert_identifier - (Optional) The identifier of the CA certificate for the DB instance.

» Timeouts

aws_docdb_cluster_instance provides the following Timeouts configuration options:

  • create - (Default 90 minutes) Used for Creating Instances, Replicas, and restoring from Snapshots
  • update - (Default 90 minutes) Used for Database modifications
  • delete - (Default 90 minutes) Used for destroying databases. This includes the time required to take snapshots

» Import

DocDB Cluster Instances can be imported using the identifier, e.g.

$ terraform import aws_docdb_cluster_instance.prod_instance_1 aurora-cluster-instance-1