decrease_node_groups_in_global_replication_group
async
¶
decrease_node_groups_in_global_replication_group(
*,
config_overrides: Optional[AsyncElastiCacheClientConfig] = None,
global_replication_group_id: Optional[String] = None,
node_group_count: Optional[Integer] = None,
global_node_groups_to_remove: Optional[GlobalNodeGroupIdList] = None,
global_node_groups_to_retain: Optional[GlobalNodeGroupIdList] = None,
apply_immediately: Optional[Boolean] = None,
) -> DecreaseNodeGroupsInGlobalReplicationGroupResult
Decreases the number of node groups in a Global datastore
Parameters:
-
global_replication_group_id(Optional[String], default:None) –The name of the Global datastore
-
node_group_count(Optional[Integer], default:None) –The number of node groups (shards) that results from the modification of the shard configuration
-
global_node_groups_to_remove(Optional[GlobalNodeGroupIdList], default:None) –If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
-
global_node_groups_to_retain(Optional[GlobalNodeGroupIdList], default:None) –If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
-
apply_immediately(Optional[Boolean], default:None) –Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
Raises:
-
GlobalReplicationGroupNotFoundFault–The Global datastore does not exist
-
InvalidGlobalReplicationGroupStateFault–The Global datastore is not available or in primary-only state.
-
InvalidParameterCombinationException–Two or more incompatible parameters were specified.
-
InvalidParameterValueException–The value for a parameter is invalid.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_elasticache/_services/async_elasti_cache.py
2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 | |