docdb_create_db_instance: Creates a new instance

View source: R/docdb_operations.R

docdb_create_db_instanceR Documentation

Creates a new instance


Creates a new instance.

See for full documentation.


  AvailabilityZone = NULL,
  PreferredMaintenanceWindow = NULL,
  AutoMinorVersionUpgrade = NULL,
  Tags = NULL,
  CopyTagsToSnapshot = NULL,
  PromotionTier = NULL,
  EnablePerformanceInsights = NULL,
  PerformanceInsightsKMSKeyId = NULL



[required] The instance identifier. This parameter is stored as a lowercase string.


  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance


[required] The compute and memory capacity of the instance; for example, db.r5.large.


[required] The name of the database engine to be used for this instance.

Valid value: docdb


The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: ⁠us-east-1d⁠


The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.


This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false


The tags to be assigned to the instance. You can assign up to 10 tags to an instance.


[required] The identifier of the cluster that the instance will belong to.


A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.


A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15


A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.


The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

paws.database documentation built on Sept. 12, 2023, 1:21 a.m.