paws.database (version 0.1.5)

docdb_create_db_instance: Creates a new DB instance

Description

Creates a new DB instance.

Usage

docdb_create_db_instance(DBInstanceIdentifier, DBInstanceClass, Engine,
  AvailabilityZone, PreferredMaintenanceWindow, AutoMinorVersionUpgrade,
  Tags, DBClusterIdentifier, PromotionTier)

Arguments

DBInstanceIdentifier

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

Constraints:

• 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

DBInstanceClass

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

Engine

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

Valid value: docdb

AvailabilityZone

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

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

PreferredMaintenanceWindow

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 AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

AutoMinorVersionUpgrade

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

Tags

The tags to be assigned to the DB instance.

DBClusterIdentifier

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

PromotionTier

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

Request syntax

svc$create_db_instance(
  DBInstanceIdentifier = "string",
  DBInstanceClass = "string",
  Engine = "string",
  AvailabilityZone = "string",
  PreferredMaintenanceWindow = "string",
  AutoMinorVersionUpgrade = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  DBClusterIdentifier = "string",
  PromotionTier = 123
)