Batch Update Cluster

memorydb_batch_update_cluster

R Documentation

Apply the service update to a list of clusters supplied

Description

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

Usage

memorydb_batch_update_cluster(ClusterNames, ServiceUpdate)

Arguments

ClusterNames

[required] The cluster names to apply the updates.

ServiceUpdate

The unique ID of the service update

Value

A list with the following syntax:

list(
  ProcessedClusters = list(
    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"
    )
  ),
  UnprocessedClusters = list(
    list(
      ClusterName = "string",
      ErrorType = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$batch_update_cluster(
  ClusterNames = list(
    "string"
  ),
  ServiceUpdate = list(
    ServiceUpdateNameToApply = "string"
  )
)