Skip to content

Update Cluster

memorydb_update_cluster R Documentation

Modifies the settings for a cluster

Description

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.

Usage

memorydb_update_cluster(ClusterName, Description, SecurityGroupIds,
  MaintenanceWindow, SnsTopicArn, SnsTopicStatus, ParameterGroupName,
  SnapshotWindow, SnapshotRetentionLimit, NodeType, EngineVersion,
  ReplicaConfiguration, ShardConfiguration, ACLName)

Arguments

ClusterName

[required] The name of the cluster to update

Description

The description of the cluster to update

SecurityGroupIds

The SecurityGroupIds to update

MaintenanceWindow

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

SnsTopicArn

The SNS topic ARN to update

SnsTopicStatus

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

ParameterGroupName

The name of the parameter group to update

SnapshotWindow

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

SnapshotRetentionLimit

The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

NodeType

A valid node type that you want to scale this cluster up or down to.

EngineVersion

The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

ReplicaConfiguration

The number of replicas that will reside in each shard

ShardConfiguration

The number of shards in the cluster

ACLName

The Access Control List that is associated with the cluster

Value

A list with the following syntax: 

list(
  Cluster = list(
    Name = "string",
    Description = "string",
    Status = "string",
    PendingUpdates = list(
      Resharding = list(
        SlotMigration = list(
          ProgressPercentage = 123.0
        )
      ),
      ACLs = list(
        ACLToApply = "string"
      ),
      ServiceUpdates = list(
        list(
          ServiceUpdateName = "string",
          Status = "available"|"in-progress"|"complete"|"scheduled"
        )
      )
    ),
    NumberOfShards = 123,
    Shards = list(
      list(
        Name = "string",
        Status = "string",
        Slots = "string",
        Nodes = list(
          list(
            Name = "string",
            Status = "string",
            AvailabilityZone = "string",
            CreateTime = as.POSIXct(
              "2015-01-01"
            ),
            Endpoint = list(
              Address = "string",
              Port = 123
            )
          )
        ),
        NumberOfNodes = 123
      )
    ),
    AvailabilityMode = "singleaz"|"multiaz",
    ClusterEndpoint = list(
      Address = "string",
      Port = 123
    ),
    NodeType = "string",
    EngineVersion = "string",
    EnginePatchVersion = "string",
    ParameterGroupName = "string",
    ParameterGroupStatus = "string",
    SecurityGroups = list(
      list(
        SecurityGroupId = "string",
        Status = "string"
      )
    ),
    SubnetGroupName = "string",
    TLSEnabled = TRUE|FALSE,
    KmsKeyId = "string",
    ARN = "string",
    SnsTopicArn = "string",
    SnsTopicStatus = "string",
    SnapshotRetentionLimit = 123,
    MaintenanceWindow = "string",
    SnapshotWindow = "string",
    ACLName = "string",
    AutoMinorVersionUpgrade = TRUE|FALSE,
    DataTiering = "true"|"false"
  )
)

Request syntax

svc$update_cluster(
  ClusterName = "string",
  Description = "string",
  SecurityGroupIds = list(
    "string"
  ),
  MaintenanceWindow = "string",
  SnsTopicArn = "string",
  SnsTopicStatus = "string",
  ParameterGroupName = "string",
  SnapshotWindow = "string",
  SnapshotRetentionLimit = 123,
  NodeType = "string",
  EngineVersion = "string",
  ReplicaConfiguration = list(
    ReplicaCount = 123
  ),
  ShardConfiguration = list(
    ShardCount = 123
  ),
  ACLName = "string"
)