[ aws . docdb ]

reset-db-cluster-parameter-group

Description

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod . To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  reset-db-cluster-parameter-group
--db-cluster-parameter-group-name <value>
[--reset-all-parameters | --no-reset-all-parameters]
[--parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--db-cluster-parameter-group-name (string)

The name of the cluster parameter group to reset.

--reset-all-parameters | --no-reset-all-parameters (boolean)

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can’t use this parameter if there is a list of parameter names specified for the Parameters parameter.

--parameters (list)

A list of parameter names in the cluster parameter group to reset to the default values. You can’t use this parameter if the ResetAllParameters parameter is set to true .

(structure)

Detailed information about an individual parameter.

ParameterName -> (string)

Specifies the name of the parameter.

ParameterValue -> (string)

Specifies the value of the parameter.

Description -> (string)

Provides a description of the parameter.

Source -> (string)

Indicates the source of the parameter value.

ApplyType -> (string)

Specifies the engine-specific parameters type.

DataType -> (string)

Specifies the valid data type for the parameter.

AllowedValues -> (string)

Specifies the valid range of values for the parameter.

IsModifiable -> (boolean)

Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

MinimumEngineVersion -> (string)

The earliest engine version to which the parameter can apply.

ApplyMethod -> (string)

Indicates when to apply parameter updates.

Shorthand Syntax:

ParameterName=string,ParameterValue=string,Description=string,Source=string,ApplyType=string,DataType=string,AllowedValues=string,IsModifiable=boolean,MinimumEngineVersion=string,ApplyMethod=string ...

JSON Syntax:

[
  {
    "ParameterName": "string",
    "ParameterValue": "string",
    "Description": "string",
    "Source": "string",
    "ApplyType": "string",
    "DataType": "string",
    "AllowedValues": "string",
    "IsModifiable": true|false,
    "MinimumEngineVersion": "string",
    "ApplyMethod": "immediate"|"pending-reboot"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To reset the specified parameter value to its defaults in an Amazon DocumentDB parameter group

The following reset-db-cluster-parameter-group example resets the parameter ttl_monitor in the Amazon DocumentDB parameter group custom3-6-param-grp to its default value.

aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --parameters ParameterName=ttl_monitor,ApplyMethod=immediate

Output:

{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

For more information, see title in the Amazon DocumentDB Developer Guide.

To reset specified or all parameter values to their defaults in an Amazon DocumentDB parameter group

The following reset-db-cluster-parameter-group example resets all parameters in the Amazon DocumentDB parameter group custom3-6-param-grp to their default value.

aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --reset-all-parameters

Output:

{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

For more information, see Resetting an Amazon DocumentDB Cluster Parameter Group in the Amazon DocumentDB Developer Guide.

Output

DBClusterParameterGroupName -> (string)

The name of a cluster parameter group.

Constraints:

• Must be from 1 to 255 letters or numbers.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Note

This value is stored as a lowercase string.