Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.
Parameters:
-
db_cluster_parameter_group_name
(Optional[String], default:
None
)
–
The name of the cluster parameter group to modify.
-
parameters
(Optional[ParametersList], default:
None
)
–
A list of parameters in the cluster parameter group to modify.
Raises:
Source code in docs_src/capo_docdb/_services/doc_db.py
| def modify_db_cluster_parameter_group(
self,
*,
config_overrides: Optional[DocDBClientConfig] = None,
db_cluster_parameter_group_name: Optional[
"capo_docdb.types.string.String"
] = None,
parameters: Optional["capo_docdb.types.parameters_list.ParametersList"] = None,
) -> "capo_docdb.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage":
"""<p> Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <note> <p>Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.</p> </note> <important> <p>After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>
Args:
db_cluster_parameter_group_name: <p>The name of the cluster parameter group to modify.</p>
parameters: <p>A list of parameters in the cluster parameter group to modify.</p>
Raises:
capo_docdb.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </p>
capo_docdb.errors.invalid_db_parameter_group_state_fault.InvalidDBParameterGroupStateFault: <p>The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.</p>
capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_docdb.types.modify_db_cluster_parameter_group_message.ModifyDBClusterParameterGroupMessage]",
) -> OperationResponse[
"capo_docdb.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage"
]:
import capo_docdb._operations.amazon_rd_sv19.modify_db_cluster_parameter_group
output, http_response = (
capo_docdb._operations.amazon_rd_sv19.modify_db_cluster_parameter_group.modify_db_cluster_parameter_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ModifyDBClusterParameterGroup")
)
input_: capo_docdb.types.modify_db_cluster_parameter_group_message.ModifyDBClusterParameterGroupMessage = {}
if db_cluster_parameter_group_name is not None:
input_["db_cluster_parameter_group_name"] = db_cluster_parameter_group_name
if parameters is not None:
input_["parameters"] = parameters
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|