Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . elasticache ]

describe-cache-parameters

Description

Returns the detailed parameter list for a particular cache parameter group.

See also: AWS API Documentation

describe-cache-parameters is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Parameters

Synopsis

  describe-cache-parameters
--cache-parameter-group-name <value>
[--source <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

The name of a specific cache parameter group to return details for.

--source (string)

The parameter types to return.

Valid values: user | system | engine-default

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output

Marker -> (string)

Provides an identifier to allow retrieval of paginated results.

Parameters -> (list)

A list of Parameter instances.

(structure)

Describes an individual setting that controls some aspect of ElastiCache behavior.

ParameterName -> (string)

The name of the parameter.

ParameterValue -> (string)

The value of the parameter.

Description -> (string)

A description of the parameter.

Source -> (string)

The source of the parameter.

DataType -> (string)

The valid data type for the parameter.

AllowedValues -> (string)

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 cache engine version to which the parameter can apply.

ChangeType -> (string)

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster .

CacheNodeTypeSpecificParameters -> (list)

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

(structure)

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

ParameterName -> (string)

The name of the parameter.

Description -> (string)

A description of the parameter.

Source -> (string)

The source of the parameter value.

DataType -> (string)

The valid data type for the parameter.

AllowedValues -> (string)

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 cache engine version to which the parameter can apply.

CacheNodeTypeSpecificValues -> (list)

A list of cache node types and their corresponding values for this parameter.

(structure)

A value that applies only to a certain cache node type.

CacheNodeType -> (string)

The cache node type for which this value applies.

Value -> (string)

The value for the cache node type.

ChangeType -> (string)

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster .