Skip to content

Commit a9dbe38

Browse files
author
AWS
committed
Amazon ElastiCache Update: Documentation update, adding clarity and rephrasing.
1 parent 4abd3f6 commit a9dbe38

File tree

2 files changed

+28
-22
lines changed

2 files changed

+28
-22
lines changed

‎.changes/next-release/feature-AmazonElastiCache-9d53af1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon ElastiCache",
4+
"contributor": "",
5+
"description": "Documentation update, adding clarity and rephrasing."
6+
}

‎services/elasticache/src/main/resources/codegen-resources/service-2.json

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@
400400
{"shape":"InvalidParameterCombinationException"},
401401
{"shape":"TagQuotaPerResourceExceeded"}
402402
],
403-
"documentation":"<p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a>.</p>"
403+
"documentation":"<p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a>.</p>"
404404
},
405405
"CreateUserGroup":{
406406
"name":"CreateUserGroup",
@@ -423,7 +423,7 @@
423423
{"shape":"InvalidParameterValueException"},
424424
{"shape":"TagQuotaPerResourceExceeded"}
425425
],
426-
"documentation":"<p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a user group. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a> </p>"
426+
"documentation":"<p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a> </p>"
427427
},
428428
"DecreaseNodeGroupsInGlobalReplicationGroup":{
429429
"name":"DecreaseNodeGroupsInGlobalReplicationGroup",
@@ -1910,11 +1910,11 @@
19101910
},
19111911
"NetworkType":{
19121912
"shape":"NetworkType",
1913-
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
1913+
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
19141914
},
19151915
"IpDiscovery":{
19161916
"shape":"IpDiscovery",
1917-
"documentation":"<p>The network type associated with the cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
1917+
"documentation":"<p>The network type associated with the cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
19181918
},
19191919
"TransitEncryptionMode":{
19201920
"shape":"TransitEncryptionMode",
@@ -2455,7 +2455,7 @@
24552455
},
24562456
"SupportedNetworkTypes":{
24572457
"shape":"NetworkTypeList",
2458-
"documentation":"<p>Either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
2458+
"documentation":"<p>Either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
24592459
}
24602460
},
24612461
"documentation":"<p>Represents the output of one of the following operations:</p> <ul> <li> <p> <code>CreateCacheSubnetGroup</code> </p> </li> <li> <p> <code>ModifyCacheSubnetGroup</code> </p> </li> </ul>",
@@ -2831,11 +2831,11 @@
28312831
},
28322832
"NetworkType":{
28332833
"shape":"NetworkType",
2834-
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>. </p>"
2834+
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>. </p>"
28352835
},
28362836
"IpDiscovery":{
28372837
"shape":"IpDiscovery",
2838-
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
2838+
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
28392839
}
28402840
},
28412841
"documentation":"<p>Represents the input of a CreateCacheCluster operation.</p>"
@@ -3024,7 +3024,7 @@
30243024
},
30253025
"Engine":{
30263026
"shape":"String",
3027-
"documentation":"<p>The name of the cache engine to be used for the clusters in this replication group. The value must be set to <code>Redis</code>.</p>"
3027+
"documentation":"<p>The name of the cache engine to be used for the clusters in this replication group. The value must be set to <code>valkey</code> or <code>redis</code>.</p>"
30283028
},
30293029
"EngineVersion":{
30303030
"shape":"String",
@@ -3092,7 +3092,7 @@
30923092
},
30933093
"AtRestEncryptionEnabled":{
30943094
"shape":"BooleanOptional",
3095-
"documentation":"<p>A flag that enables encryption at rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the replication group is created. To enable encryption at rest on a replication group you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create the replication group. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using Redis OSS version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>"
3095+
"documentation":"<p>A flag that enables encryption at rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the replication group is created. To enable encryption at rest on a replication group you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create the replication group. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using Valkey 7.2 and later, Redis OSS version <code>3.2.6</code>, or Redis OSS <code>4.x</code> and later.</p> <p>Default: <code>true</code> when using Valkey, <code>false</code> when using Redis OSS</p>"
30963096
},
30973097
"KmsKeyId":{
30983098
"shape":"String",
@@ -3112,11 +3112,11 @@
31123112
},
31133113
"NetworkType":{
31143114
"shape":"NetworkType",
3115-
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
3115+
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
31163116
},
31173117
"IpDiscovery":{
31183118
"shape":"IpDiscovery",
3119-
"documentation":"<p>The network type you choose when creating a replication group, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
3119+
"documentation":"<p>The network type you choose when creating a replication group, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
31203120
},
31213121
"TransitEncryptionMode":{
31223122
"shape":"TransitEncryptionMode",
@@ -3289,7 +3289,7 @@
32893289
},
32903290
"Engine":{
32913291
"shape":"EngineType",
3292-
"documentation":"<p>The current supported value is Redis user. </p>"
3292+
"documentation":"<p>Sets the engine listed in a user group. The options are valkey or redis.</p>"
32933293
},
32943294
"UserIds":{
32953295
"shape":"UserIdListInput",
@@ -3320,7 +3320,7 @@
33203320
},
33213321
"Engine":{
33223322
"shape":"EngineType",
3323-
"documentation":"<p>The current supported value is Redis. </p>"
3323+
"documentation":"<p>The options are valkey or redis. </p>"
33243324
},
33253325
"Passwords":{
33263326
"shape":"PasswordListInput",
@@ -5203,7 +5203,7 @@
52035203
},
52045204
"IpDiscovery":{
52055205
"shape":"IpDiscovery",
5206-
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
5206+
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
52075207
}
52085208
},
52095209
"documentation":"<p>Represents the input of a <code>ModifyCacheCluster</code> operation.</p>"
@@ -5415,7 +5415,7 @@
54155415
},
54165416
"IpDiscovery":{
54175417
"shape":"IpDiscovery",
5418-
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
5418+
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
54195419
},
54205420
"TransitEncryptionEnabled":{
54215421
"shape":"BooleanOptional",
@@ -5552,7 +5552,7 @@
55525552
},
55535553
"Engine":{
55545554
"shape":"EngineType",
5555-
"documentation":"<p>The engine for a user group. </p>"
5555+
"documentation":"<p>Modifies the engine listed in a user group. The options are valkey or redis.</p>"
55565556
}
55575557
}
55585558
},
@@ -5586,7 +5586,7 @@
55865586
},
55875587
"Engine":{
55885588
"shape":"EngineType",
5589-
"documentation":"<p>The engine for a specific user. </p>"
5589+
"documentation":"<p>Modifies the engine listed for a user. The options are valkey or redis.</p>"
55905590
}
55915591
}
55925592
},
@@ -6420,11 +6420,11 @@
64206420
},
64216421
"NetworkType":{
64226422
"shape":"NetworkType",
6423-
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
6423+
"documentation":"<p>Must be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
64246424
},
64256425
"IpDiscovery":{
64266426
"shape":"IpDiscovery",
6427-
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
6427+
"documentation":"<p>The network type you choose when modifying a cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
64286428
},
64296429
"TransitEncryptionMode":{
64306430
"shape":"TransitEncryptionMode",
@@ -7446,7 +7446,7 @@
74467446
},
74477447
"SupportedNetworkTypes":{
74487448
"shape":"NetworkTypeList",
7449-
"documentation":"<p>Either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
7449+
"documentation":"<p>Either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the <a href=\"http://aws.amazon.com/ec2/nitro/\">Nitro system</a>.</p>"
74507450
}
74517451
},
74527452
"documentation":"<p>Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.</p>"
@@ -7825,7 +7825,7 @@
78257825
},
78267826
"Engine":{
78277827
"shape":"EngineType",
7828-
"documentation":"<p>The current supported value is Redis.</p>"
7828+
"documentation":"<p>The options are valkey or redis.</p>"
78297829
},
78307830
"MinimumEngineVersion":{
78317831
"shape":"String",
@@ -7874,7 +7874,7 @@
78747874
},
78757875
"Engine":{
78767876
"shape":"EngineType",
7877-
"documentation":"<p>The current supported value is Redis user. </p>"
7877+
"documentation":"<p>The options are valkey or redis.</p>"
78787878
},
78797879
"UserIds":{
78807880
"shape":"UserIdList",

0 commit comments

Comments
 (0)