Skip to content

Create Cluster

docdbelastic_create_cluster R Documentation

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure

Description

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Usage

docdbelastic_create_cluster(adminUserName, adminUserPassword, authType,
  backupRetentionPeriod, clientToken, clusterName, kmsKeyId,
  preferredBackupWindow, preferredMaintenanceWindow, shardCapacity,
  shardCount, shardInstanceCount, subnetIds, tags, vpcSecurityGroupIds)

Arguments

adminUserName

[required] The name of the Amazon DocumentDB elastic clusters administrator.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word.

adminUserPassword

[required] The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.

Constraints:

  • Must contain from 8 to 100 characters.

  • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

authType

[required] The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

backupRetentionPeriod

The number of days for which automatic snapshots are retained.

clientToken

The client token for the elastic cluster.

clusterName

[required] The name of the new elastic cluster. 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: my-cluster

kmsKeyId

The KMS key identifier to use to encrypt the new elastic cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

preferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

preferredMaintenanceWindow

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

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

Default: 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.

shardCapacity

[required] The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCount

[required] The number of shards assigned to the elastic cluster. Maximum is 32.

shardInstanceCount

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

subnetIds

The Amazon EC2 subnet IDs for the new elastic cluster.

tags

The tags to be assigned to the new elastic cluster.

vpcSecurityGroupIds

A list of EC2 VPC security groups to associate with the new elastic cluster.

Value

A list with the following syntax: 

list(
  cluster = list(
    adminUserName = "string",
    authType = "PLAIN_TEXT"|"SECRET_ARN",
    backupRetentionPeriod = 123,
    clusterArn = "string",
    clusterEndpoint = "string",
    clusterName = "string",
    createTime = "string",
    kmsKeyId = "string",
    preferredBackupWindow = "string",
    preferredMaintenanceWindow = "string",
    shardCapacity = 123,
    shardCount = 123,
    shardInstanceCount = 123,
    shards = list(
      list(
        createTime = "string",
        shardId = "string",
        status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"VPC_ENDPOINT_LIMIT_EXCEEDED"|"IP_ADDRESS_LIMIT_EXCEEDED"|"INVALID_SECURITY_GROUP_ID"|"INVALID_SUBNET_ID"|"INACCESSIBLE_ENCRYPTION_CREDS"|"INACCESSIBLE_SECRET_ARN"|"INACCESSIBLE_VPC_ENDPOINT"|"INCOMPATIBLE_NETWORK"|"MERGING"|"MODIFYING"|"SPLITTING"|"COPYING"|"STARTING"|"STOPPING"|"STOPPED"
      )
    ),
    status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"VPC_ENDPOINT_LIMIT_EXCEEDED"|"IP_ADDRESS_LIMIT_EXCEEDED"|"INVALID_SECURITY_GROUP_ID"|"INVALID_SUBNET_ID"|"INACCESSIBLE_ENCRYPTION_CREDS"|"INACCESSIBLE_SECRET_ARN"|"INACCESSIBLE_VPC_ENDPOINT"|"INCOMPATIBLE_NETWORK"|"MERGING"|"MODIFYING"|"SPLITTING"|"COPYING"|"STARTING"|"STOPPING"|"STOPPED",
    subnetIds = list(
      "string"
    ),
    vpcSecurityGroupIds = list(
      "string"
    )
  )
)

Request syntax

svc$create_cluster(
  adminUserName = "string",
  adminUserPassword = "string",
  authType = "PLAIN_TEXT"|"SECRET_ARN",
  backupRetentionPeriod = 123,
  clientToken = "string",
  clusterName = "string",
  kmsKeyId = "string",
  preferredBackupWindow = "string",
  preferredMaintenanceWindow = "string",
  shardCapacity = 123,
  shardCount = 123,
  shardInstanceCount = 123,
  subnetIds = list(
    "string"
  ),
  tags = list(
    "string"
  ),
  vpcSecurityGroupIds = list(
    "string"
  )
)