update-parameter-group¶

Description¶

Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

Synopsis¶

  update-parameter-group
--parameter-group-name <value>
--parameter-name-values <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--parameter-group-name (string)

The name of the parameter group to update.

--parameter-name-values (list)

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.

(structure)

Describes a name-value pair that is used to update the value of a parameter.

ParameterName -> (string)

The name of the parameter

ParameterValue -> (string)

The value of the parameter

Shorthand Syntax:

ParameterName=string,ParameterValue=string ...

JSON Syntax:

[
  {
    "ParameterName": "string",
    "ParameterValue": "string"
  }
  ...
]

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update a parameter group

The following update-parameter-group`` updates a parameter group.

aws memorydb update-parameter-group \
    --parameter-group-name my-parameter-group \
    --parameter-name-values "ParameterName=activedefrag, ParameterValue=no"

Output:

{
    "ParameterGroup": {
        "Name": "my-parameter-group",
        "Family": "memorydb_redis6",
        "Description": "my parameter group",
        "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:parametergroup/my-parameter-group"
    }
}

For more information, see Modifying a parameter group in the MemoryDB User Guide.

Output¶

ParameterGroup -> (structure)

The updated parameter group

Name -> (string)

The name of the parameter group

Family -> (string)

The name of the parameter group family that this parameter group is compatible with.

Description -> (string)

A description of the parameter group

ARN -> (string)

The Amazon Resource Name (ARN) of the parameter group

Table of Contents

Feedback

User Guide