[ aws . elasticache ]

modify-cache-parameter-group

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--cache-parameter-group-name (string)

The name of the cache parameter group to modify.

--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 modified 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.

See ‘aws help’ for descriptions of global parameters.

Examples

To modify a cache parameter group

The following modify-cache-parameter-group example modifies the parameters of the specified cache parameter group.

aws elasticache modify-cache-parameter-group \
    --cache-parameter-group-name "mygroup" \
    --parameter-name-values "ParameterName=activedefrag, ParameterValue=no"

Output:

{
    "CacheParameterGroupName": "mygroup"
}

For more information, see Modifying a Parameter Group in the Elasticache User Guide.

Output

CacheParameterGroupName -> (string)

The name of the cache parameter group.