Skip to content

increase_node_groups_in_global_replication_group

increase_node_groups_in_global_replication_group(
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    global_replication_group_id: Optional[String] = None,
    node_group_count: Optional[Integer] = None,
    regional_configurations: Optional[RegionalConfigurationList] = None,
    apply_immediately: Optional[Boolean] = None,
) -> IncreaseNodeGroupsInGlobalReplicationGroupResult

Increase the number of node groups in the Global datastore

Parameters:

  • global_replication_group_id (Optional[String], default: None ) –

    The name of the Global datastore

  • node_group_count (Optional[Integer], default: None ) –

    Total number of node groups you want

  • regional_configurations (Optional[RegionalConfigurationList], default: None ) –

    Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

  • apply_immediately (Optional[Boolean], default: None ) –

    Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

Raises:

Source code in docs_src/capo_elasticache/_services/elasti_cache.py
def increase_node_groups_in_global_replication_group(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    global_replication_group_id: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
    node_group_count: Optional["capo_elasticache.types.integer.Integer"] = None,
    regional_configurations: Optional[
        "capo_elasticache.types.regional_configuration_list.RegionalConfigurationList"
    ] = None,
    apply_immediately: Optional["capo_elasticache.types.boolean.Boolean"] = None,
) -> "capo_elasticache.types.increase_node_groups_in_global_replication_group_result.IncreaseNodeGroupsInGlobalReplicationGroupResult":
    """<p>Increase the number of node groups in the Global datastore</p>

    Args:
        global_replication_group_id: <p>The name of the Global datastore</p>
        node_group_count: <p>Total number of node groups you want</p>
        regional_configurations: <p>Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore</p>
        apply_immediately: <p>Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.</p>

    Raises:
        capo_elasticache.errors.global_replication_group_not_found_fault.GlobalReplicationGroupNotFoundFault: <p>The Global datastore does not exist</p>
        capo_elasticache.errors.invalid_global_replication_group_state_fault.InvalidGlobalReplicationGroupStateFault: <p>The Global datastore is not available or in primary-only state.</p>
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_elasticache.types.increase_node_groups_in_global_replication_group_message.IncreaseNodeGroupsInGlobalReplicationGroupMessage]",
    ) -> OperationResponse[
        "capo_elasticache.types.increase_node_groups_in_global_replication_group_result.IncreaseNodeGroupsInGlobalReplicationGroupResult"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.increase_node_groups_in_global_replication_group

        output, http_response = (
            capo_elasticache._operations.amazon_elasti_cache_v9.increase_node_groups_in_global_replication_group.increase_node_groups_in_global_replication_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("IncreaseNodeGroupsInGlobalReplicationGroup"),
    )
    input_: capo_elasticache.types.increase_node_groups_in_global_replication_group_message.IncreaseNodeGroupsInGlobalReplicationGroupMessage = {}
    if global_replication_group_id is not None:
        input_["global_replication_group_id"] = global_replication_group_id
    if node_group_count is not None:
        input_["node_group_count"] = node_group_count
    if regional_configurations is not None:
        input_["regional_configurations"] = regional_configurations
    if apply_immediately is not None:
        input_["apply_immediately"] = apply_immediately

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output