Modifies the parameters of a DB 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 without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
Parameters:
-
db_cluster_parameter_group_name
(Optional[String], default:
None
)
–
The name of the DB cluster parameter group to modify.
-
parameters
(Optional[ParametersList], default:
None
)
–
A list of parameters in the DB cluster parameter group to modify.
Raises:
Source code in docs_src/capo_neptune/_services/neptune.py
| def modify_db_cluster_parameter_group(
self,
*,
config_overrides: Optional[NeptuneClientConfig] = None,
db_cluster_parameter_group_name: Optional[
"capo_neptune.types.string.String"
] = None,
parameters: Optional[
"capo_neptune.types.parameters_list.ParametersList"
] = None,
) -> "capo_neptune.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage":
"""<p> Modifies the parameters of a DB 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 without failover to the DB cluster associated with the parameter group before the change can take effect.</p> </note> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the Amazon Neptune console or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified.</p> </important>
Args:
db_cluster_parameter_group_name: <p>The name of the DB cluster parameter group to modify.</p>
parameters: <p>A list of parameters in the DB cluster parameter group to modify.</p>
Raises:
capo_neptune.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group.</p>
capo_neptune.errors.invalid_db_parameter_group_state_fault.InvalidDBParameterGroupStateFault: <p>The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.</p>
capo_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_neptune.types.modify_db_cluster_parameter_group_message.ModifyDBClusterParameterGroupMessage]",
) -> OperationResponse[
"capo_neptune.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage"
]:
import capo_neptune._operations.amazon_rd_sv19.modify_db_cluster_parameter_group
output, http_response = (
capo_neptune._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_neptune.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
|