Modify Db Cluster Parameter Group

rds_modify_db_cluster_parameter_group

R Documentation

Modifies the parameters of a DB cluster parameter group¶

Description¶

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.

There are two types of parameters - dynamic parameters and static parameters. Changes to dynamic parameters are applied to the DB cluster immediately without a reboot. Changes to static parameters are applied only after the DB cluster is rebooted, which can be done using reboot_db_cluster operation. You can use the Parameter Groups option of the Amazon RDS console or the describe_db_cluster_parameters operation to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Usage¶

rds_modify_db_cluster_parameter_group(DBClusterParameterGroupName,
  Parameters)

Arguments¶

DBClusterParameterGroupName

[required] The name of the DB cluster parameter group to modify.

Parameters

[required] A list of parameters in the DB cluster parameter group to modify.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.

Value¶

A list with the following syntax:

list(
  DBClusterParameterGroupName = "string"
)

Request syntax¶

svc$modify_db_cluster_parameter_group(
  DBClusterParameterGroupName = "string",
  Parameters = list(
    list(
      ParameterName = "string",
      ParameterValue = "string",
      Description = "string",
      Source = "string",
      ApplyType = "string",
      DataType = "string",
      AllowedValues = "string",
      IsModifiable = TRUE|FALSE,
      MinimumEngineVersion = "string",
      ApplyMethod = "immediate"|"pending-reboot",
      SupportedEngineModes = list(
        "string"
      )
    )
  )
)

Examples¶

## Not run: 
# This example immediately changes the specified setting for the specified
# DB cluster parameter group.
svc$modify_db_cluster_parameter_group(
  DBClusterParameterGroupName = "mydbclusterparametergroup",
  Parameters = list(
    list(
      ApplyMethod = "immediate",
      ParameterName = "time_zone",
      ParameterValue = "America/Phoenix"
    )
  )
)

## End(Not run)