Modifies an elastic cluster¶

Description¶

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

Usage¶

docdbelastic_update_cluster(adminUserPassword, authType,
  backupRetentionPeriod, clientToken, clusterArn, preferredBackupWindow,
  preferredMaintenanceWindow, shardCapacity, shardCount,
  shardInstanceCount, subnetIds, vpcSecurityGroupIds)

Arguments¶

adminUserPassword

The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.
authType

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.
clusterArn

[required] The ARN identifier of the elastic cluster.
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

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

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 elastic cluster.
vpcSecurityGroupIds

A list of EC2 VPC security groups to associate with the 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"|"MAINTENANCE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
      )
    ),
    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"|"MAINTENANCE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE",
    subnetIds = list(
      "string"
    ),
    vpcSecurityGroupIds = list(
      "string"
    )
  )
)

Request syntax¶

svc$update_cluster(
  adminUserPassword = "string",
  authType = "PLAIN_TEXT"|"SECRET_ARN",
  backupRetentionPeriod = 123,
  clientToken = "string",
  clusterArn = "string",
  preferredBackupWindow = "string",
  preferredMaintenanceWindow = "string",
  shardCapacity = 123,
  shardCount = 123,
  shardInstanceCount = 123,
  subnetIds = list(
    "string"
  ),
  vpcSecurityGroupIds = list(
    "string"
  )
)