dax_decrease_replication_factor: Removes one or more nodes from a DAX cluster

Description Usage Arguments Value Request syntax

View source: R/dax_operations.R

Description

Removes one or more nodes from a DAX cluster.

You cannot use decrease_replication_factor to remove the last node in a DAX cluster. If you need to do this, use delete_cluster instead.

Usage

1
2
dax_decrease_replication_factor(ClusterName, NewReplicationFactor,
  AvailabilityZones, NodeIdsToRemove)

Arguments

ClusterName

[required] The name of the DAX cluster from which you want to remove nodes.

NewReplicationFactor

[required] The new number of nodes for the DAX cluster.

AvailabilityZones

The Availability Zone(s) from which to remove nodes.

NodeIdsToRemove

The unique identifiers of the nodes to be removed from the cluster.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
list(
  Cluster = list(
    ClusterName = "string",
    Description = "string",
    ClusterArn = "string",
    TotalNodes = 123,
    ActiveNodes = 123,
    NodeType = "string",
    Status = "string",
    ClusterDiscoveryEndpoint = list(
      Address = "string",
      Port = 123
    ),
    NodeIdsToRemove = list(
      "string"
    ),
    Nodes = list(
      list(
        NodeId = "string",
        Endpoint = list(
          Address = "string",
          Port = 123
        ),
        NodeCreateTime = as.POSIXct(
          "2015-01-01"
        ),
        AvailabilityZone = "string",
        NodeStatus = "string",
        ParameterGroupStatus = "string"
      )
    ),
    PreferredMaintenanceWindow = "string",
    NotificationConfiguration = list(
      TopicArn = "string",
      TopicStatus = "string"
    ),
    SubnetGroup = "string",
    SecurityGroups = list(
      list(
        SecurityGroupIdentifier = "string",
        Status = "string"
      )
    ),
    IamRoleArn = "string",
    ParameterGroup = list(
      ParameterGroupName = "string",
      ParameterApplyStatus = "string",
      NodeIdsToReboot = list(
        "string"
      )
    ),
    SSEDescription = list(
      Status = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
svc$decrease_replication_factor(
  ClusterName = "string",
  NewReplicationFactor = 123,
  AvailabilityZones = list(
    "string"
  ),
  NodeIdsToRemove = list(
    "string"
  )
)

paws.database documentation built on March 9, 2021, 5:11 p.m.