Listing Parameter Groups by Name - Amazon ElastiCache for Redis

Listing Parameter Groups by Name

You can list the parameter groups using the ElastiCache console, the AWS CLI, or the ElastiCache API.

Listing Parameter Groups by Name (Console)

The following procedure shows how to view a list of the parameter groups using the ElastiCache console.

To list parameter groups using the ElastiCache console

  1. Sign in to the AWS Management Console and open the ElastiCache console at https://console.aws.amazon.com/elasticache/.

  2. To see a list of all available parameter groups, in the left hand navigation pane choose Parameter Groups.

Listing Parameter Groups by Name (AWS CLI)

To generate a list of parameter groups using the AWS CLI, use the command describe-cache-parameter-groups. If you provide a parameter group's name, only that parameter group will be listed. If you do not provide a parameter group's name, up to --max-records parameter groups will be listed. In either case, the parameter group's name, family, and description are listed.

The following sample code lists the parameter group myRed28.

For Linux, macOS, or Unix:

aws elasticache describe-cache-parameter-groups \ --cache-parameter-group-name myRed28

For Windows:

aws elasticache describe-cache-parameter-groups ^ --cache-parameter-group-name myRed28

The output of this command will look something like this, listing the name, family, and description for the parameter group.

{ "CacheParameterGroups": [ { "CacheParameterGroupName": "myRed28", "CacheParameterGroupFamily": "redis2.8", "Description": "My first parameter group" } ] }

The following sample code lists the parameter group myRed56 for parameter groups running on Redis engine version 5.0.6 onwards. If the parameter group is part of a Replication Across AWS Regions Using Global Datastore, the IsGlobal property value returned in the output will be Yes.

For Linux, macOS, or Unix:

aws elasticache describe-cache-parameter-groups \ --cache-parameter-group-name myRed56

For Windows:

aws elasticache describe-cache-parameter-groups ^ --cache-parameter-group-name myRed56

The output of this command will look something like this, listing the name, family, isGlobal and description for the parameter group.

{ "CacheParameterGroups": [ { "CacheParameterGroupName": "myRed56", "CacheParameterGroupFamily": "redis5.0", "Description": "My first parameter group", "IsGlobal": "yes" } ] }

The following sample code lists up to 10 parameter groups.

aws elasticache describe-cache-parameter-groups --max-records 20

The JSON output of this command will look something like this, listing the name, family, description and, in the case of redis5.6 whether the parameter group is part of a Global Datastore (isGlobal), for each parameter group.

{ "CacheParameterGroups": [ { "CacheParameterGroupName": "custom-redis32", "CacheParameterGroupFamily": "redis3.2", "Description": "custom parameter group with reserved-memory > 0" }, { "CacheParameterGroupName": "default.memcached1.4", "CacheParameterGroupFamily": "memcached1.4", "Description": "Default parameter group for memcached1.4" }, { "CacheParameterGroupName": "default.redis2.6", "CacheParameterGroupFamily": "redis2.6", "Description": "Default parameter group for redis2.6" }, { "CacheParameterGroupName": "default.redis2.8", "CacheParameterGroupFamily": "redis2.8", "Description": "Default parameter group for redis2.8" }, { "CacheParameterGroupName": "default.redis3.2", "CacheParameterGroupFamily": "redis3.2", "Description": "Default parameter group for redis3.2" }, { "CacheParameterGroupName": "default.redis3.2.cluster.on", "CacheParameterGroupFamily": "redis3.2", "Description": "Customized default parameter group for redis3.2 with cluster mode on" }, { "CacheParameterGroupName": "default.redis5.6.cluster.on", "CacheParameterGroupFamily": "redis5.0", "Description": "Customized default parameter group for redis5.6 with cluster mode on", "isGlobal": "yes" }, ] }

For more information, see describe-cache-parameter-groups.

Listing Parameter Groups by Name (ElastiCache API)

To generate a list of parameter groups using the ElastiCache API, use the DescribeCacheParameterGroups action. If you provide a parameter group's name, only that parameter group will be listed. If you do not provide a parameter group's name, up to MaxRecords parameter groups will be listed. In either case, the parameter group's name, family, and description are listed.

The following sample code lists up to 10 parameter groups.

https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheParameterGroups &MaxRecords=10 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &Version=2015-02-02 &X-Amz-Credential=<credential>

The response from this action will look something like this, listing the name, family, description and, in the case of redis5.6 if the parameter group belongs to a Global Datastore (isGlobal), for each parameter group.

<DescribeCacheParameterGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2013-06-15/"> <DescribeCacheParameterGroupsResult> <CacheParameterGroups> <CacheParameterGroup> <CacheParameterGroupName>myRedis28</CacheParameterGroupName> <CacheParameterGroupFamily>redis2.8</CacheParameterGroupFamily> <Description>My custom Redis 2.8 parameter group</Description> </CacheParameterGroup> <CacheParameterGroup> <CacheParameterGroupName>myMem14</CacheParameterGroupName> <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily> <Description>My custom Memcached 1.4 parameter group</Description> </CacheParameterGroup> <CacheParameterGroup> <CacheParameterGroupName>myRedis56</CacheParameterGroupName> <CacheParameterGroupFamily>redis5.0</CacheParameterGroupFamily> <Description>My custom redis 5.6 parameter group</Description> <isGlobal>yes</isGlobal> </CacheParameterGroup> </CacheParameterGroups> </DescribeCacheParameterGroupsResult> <ResponseMetadata> <RequestId>3540cc3d-af48-11e0-97f9-279771c4477e</RequestId> </ResponseMetadata> </DescribeCacheParameterGroupsResponse>

The following sample code lists the parameter group myRed28.

https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheParameterGroups &CacheParameterGroupName=myRed28 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &Version=2015-02-02 &X-Amz-Credential=<credential>

The response from this action will look something like this, listing the name, family, and description.

<DescribeCacheParameterGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2013-06-15/"> <DescribeCacheParameterGroupsResult> <CacheParameterGroups> <CacheParameterGroup> <CacheParameterGroupName>myRed28</CacheParameterGroupName> <CacheParameterGroupFamily>redis2.8</CacheParameterGroupFamily> <Description>My custom Redis 2.8 parameter group</Description> </CacheParameterGroup> </CacheParameterGroups> </DescribeCacheParameterGroupsResult> <ResponseMetadata> <RequestId>3540cc3d-af48-11e0-97f9-279771c4477e</RequestId> </ResponseMetadata> </DescribeCacheParameterGroupsResponse>

The following sample code lists the parameter group myRed56.

https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheParameterGroups &CacheParameterGroupName=myRed56 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &Version=2015-02-02 &X-Amz-Credential=<credential>

The response from this action will look something like this, listing the name, family, description and whether the parameter group is part of a Global Datastore (isGlobal).

<DescribeCacheParameterGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2013-06-15/"> <DescribeCacheParameterGroupsResult> <CacheParameterGroups> <CacheParameterGroup> <CacheParameterGroupName>myRed56</CacheParameterGroupName> <CacheParameterGroupFamily>redis5.0</CacheParameterGroupFamily> <Description>My custom Redis 5.6 parameter group</Description> <isGlobal>yes</isGlobal> </CacheParameterGroup> </CacheParameterGroups> </DescribeCacheParameterGroupsResult> <ResponseMetadata> <RequestId>3540cc3d-af48-11e0-97f9-279771c4477e</RequestId> </ResponseMetadata> </DescribeCacheParameterGroupsResponse>

The following sample code lists up to 10 parameter groups.

https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheParameterGroups &MaxRecords=10 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &Version=2015-02-02 &X-Amz-Credential=<credential>

The response from this action will look something like this, listing the name, family, description and, in the case of redis5.6, whether the parameter group is part of a Global Datastore (isGlobal), for each parameter group.

<DescribeCacheParameterGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2013-06-15/"> <DescribeCacheParameterGroupsResult> <CacheParameterGroups> <CacheParameterGroup> <CacheParameterGroupName>myRedis28</CacheParameterGroupName> <CacheParameterGroupFamily>redis2.8</CacheParameterGroupFamily> <Description>My custom Redis 2.8 parameter group</Description> </CacheParameterGroup> <CacheParameterGroup> <CacheParameterGroupName>myMem14</CacheParameterGroupName> <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily> <Description>My custom Memcached 1.4 parameter group</Description> </CacheParameterGroup> </CacheParameterGroups> <CacheParameterGroup> <CacheParameterGroupName>myRedis56</CacheParameterGroupName> <CacheParameterGroupFamily>redis5.0</CacheParameterGroupFamily> <Description>My custom Redis 5.6 parameter group</Description> <isGlobal>yes</isGlobal> </CacheParameterGroup> </DescribeCacheParameterGroupsResult> <ResponseMetadata> <RequestId>3540cc3d-af48-11e0-97f9-279771c4477e</RequestId> </ResponseMetadata> </DescribeCacheParameterGroupsResponse>

For more information, see DescribeCacheParameterGroups.