elasticache_decrease_node_groups_in_global_replication_group: Decreases the number of node groups in a Global Datastore

Description

Decreases the number of node groups in a Global Datastore

Usage

elasticache_decrease_node_groups_in_global_replication_group(
  GlobalReplicationGroupId, NodeGroupCount, GlobalNodeGroupsToRemove,
  GlobalNodeGroupsToRetain, ApplyImmediately)

Value

A list with the following syntax:

list(
  GlobalReplicationGroup = list(
    GlobalReplicationGroupId = "string",
    GlobalReplicationGroupDescription = "string",
    Status = "string",
    CacheNodeType = "string",
    Engine = "string",
    EngineVersion = "string",
    Members = list(
      list(
        ReplicationGroupId = "string",
        ReplicationGroupRegion = "string",
        Role = "string",
        AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
        Status = "string"
      )
    ),
    ClusterEnabled = TRUE|FALSE,
    GlobalNodeGroups = list(
      list(
        GlobalNodeGroupId = "string",
        Slots = "string"
      )
    ),
    AuthTokenEnabled = TRUE|FALSE,
    TransitEncryptionEnabled = TRUE|FALSE,
    AtRestEncryptionEnabled = TRUE|FALSE,
    ARN = "string"
  )
)

Arguments

GlobalReplicationGroupId: [required] The name of the Global Datastore
NodeGroupCount: [required] The number of node groups (shards) that results from the modification of the shard configuration
GlobalNodeGroupsToRemove: If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
GlobalNodeGroupsToRetain: If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
ApplyImmediately: [required] Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Request syntax

svc$decrease_node_groups_in_global_replication_group(
  GlobalReplicationGroupId = "string",
  NodeGroupCount = 123,
  GlobalNodeGroupsToRemove = list(
    "string"
  ),
  GlobalNodeGroupsToRetain = list(
    "string"
  ),
  ApplyImmediately = TRUE|FALSE
)