Skip to content

Commit c085c6b

Browse files
author
AWS
committed
Amazon ElastiCache Update: Amazon ElastiCache for Redis 5.0.5 now allows you to modify authentication tokens by setting and rotating new tokens. You can now modify active tokens while in use, or add brand-new tokens to existing encryption-in-transit enabled clusters that were previously setup without authentication tokens. This is a two-step process that allows you to set and rotate the token without interrupting client requests.
1 parent fc7bcde commit c085c6b

File tree

2 files changed

+57
-6
lines changed

2 files changed

+57
-6
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon ElastiCache",
4+
"description": "Amazon ElastiCache for Redis 5.0.5 now allows you to modify authentication tokens by setting and rotating new tokens. You can now modify active tokens while in use, or add brand-new tokens to existing encryption-in-transit enabled clusters that were previously setup without authentication tokens. This is a two-step process that allows you to set and rotate the token without interrupting client requests."
5+
}

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

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1019,6 +1019,20 @@
10191019
},
10201020
"documentation":"<p>Represents the allowed node types you can use to modify your cluster or replication group.</p>"
10211021
},
1022+
"AuthTokenUpdateStatus":{
1023+
"type":"string",
1024+
"enum":[
1025+
"SETTING",
1026+
"ROTATING"
1027+
]
1028+
},
1029+
"AuthTokenUpdateStrategyType":{
1030+
"type":"string",
1031+
"enum":[
1032+
"SET",
1033+
"ROTATE"
1034+
]
1035+
},
10221036
"AuthorizationAlreadyExistsFault":{
10231037
"type":"structure",
10241038
"members":{
@@ -1230,6 +1244,10 @@
12301244
"shape":"BooleanOptional",
12311245
"documentation":"<p>A flag that enables using an <code>AuthToken</code> (password) when issuing Redis commands.</p> <p>Default: <code>false</code> </p>"
12321246
},
1247+
"AuthTokenLastModifiedDate":{
1248+
"shape":"TStamp",
1249+
"documentation":"<p>The date the auth token was last modified</p>"
1250+
},
12331251
"TransitEncryptionEnabled":{
12341252
"shape":"BooleanOptional",
12351253
"documentation":"<p>A flag that enables in-transit encryption when set to <code>true</code>.</p> <p>You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>"
@@ -2030,7 +2048,7 @@
20302048
},
20312049
"AuthToken":{
20322050
"shape":"String",
2033-
"documentation":"<p> <b>Reserved parameter.</b> The password used to access a password protected server.</p> <p>Password constraints:</p> <ul> <li> <p>Must be only printable ASCII characters.</p> </li> <li> <p>Must be at least 16 characters and no more than 128 characters in length.</p> </li> <li> <p>Cannot contain any of the following characters: '/', '\"', or '@'. </p> </li> </ul> <p>For more information, see <a href=\"http://redis.io/commands/AUTH\">AUTH password</a> at http://redis.io/commands/AUTH.</p>"
2051+
"documentation":"<p> <b>Reserved parameter.</b> The password used to access a password protected server.</p> <p>Password constraints:</p> <ul> <li> <p>Must be only printable ASCII characters.</p> </li> <li> <p>Must be at least 16 characters and no more than 128 characters in length.</p> </li> <li> <p>The only permitted printable special characters are !, &amp;, #, $, ^, &lt;, &gt;, and -. Other printable special characters cannot be used in the AUTH token.</p> </li> </ul> <p>For more information, see <a href=\"http://redis.io/commands/AUTH\">AUTH password</a> at http://redis.io/commands/AUTH.</p>"
20342052
}
20352053
},
20362054
"documentation":"<p>Represents the input of a CreateCacheCluster operation.</p>"
@@ -2232,7 +2250,7 @@
22322250
},
22332251
"AuthToken":{
22342252
"shape":"String",
2235-
"documentation":"<p> <b>Reserved parameter.</b> The password used to access a password protected server.</p> <p> <code>AuthToken</code> can be specified only on replication groups where <code>TransitEncryptionEnabled</code> is <code>true</code>.</p> <important> <p>For HIPAA compliance, you must specify <code>TransitEncryptionEnabled</code> as <code>true</code>, an <code>AuthToken</code>, and a <code>CacheSubnetGroup</code>.</p> </important> <p>Password constraints:</p> <ul> <li> <p>Must be only printable ASCII characters.</p> </li> <li> <p>Must be at least 16 characters and no more than 128 characters in length.</p> </li> <li> <p>Cannot contain any of the following characters: '/', '\"', or '@'. </p> </li> </ul> <p>For more information, see <a href=\"http://redis.io/commands/AUTH\">AUTH password</a> at http://redis.io/commands/AUTH.</p>"
2253+
"documentation":"<p> <b>Reserved parameter.</b> The password used to access a password protected server.</p> <p> <code>AuthToken</code> can be specified only on replication groups where <code>TransitEncryptionEnabled</code> is <code>true</code>.</p> <important> <p>For HIPAA compliance, you must specify <code>TransitEncryptionEnabled</code> as <code>true</code>, an <code>AuthToken</code>, and a <code>CacheSubnetGroup</code>.</p> </important> <p>Password constraints:</p> <ul> <li> <p>Must be only printable ASCII characters.</p> </li> <li> <p>Must be at least 16 characters and no more than 128 characters in length.</p> </li> <li> <p>The only permitted printable special characters are !, &amp;, #, $, ^, &lt;, &gt;, and -. Other printable special characters cannot be used in the AUTH token.</p> </li> </ul> <p>For more information, see <a href=\"http://redis.io/commands/AUTH\">AUTH password</a> at http://redis.io/commands/AUTH.</p>"
22362254
},
22372255
"TransitEncryptionEnabled":{
22382256
"shape":"BooleanOptional",
@@ -3169,7 +3187,7 @@
31693187
},
31703188
"AZMode":{
31713189
"shape":"AZMode",
3172-
"documentation":"<p>Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.</p> <p>Valid values: <code>single-az</code> | <code>cross-az</code>.</p> <p>This option is only supported for Memcached clusters.</p> <note> <p>You cannot specify <code>single-az</code> if the Memcached cluster already has cache nodes in different Availability Zones. If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone.</p> <p>Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the <b>Availability Zone Considerations</b> section of <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html\">Cache Node Considerations for Memcached</a>.</p> </note>"
3190+
"documentation":"<p>Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.</p> <p>Valid values: <code>single-az</code> | <code>cross-az</code>.</p> <p>This option is only supported for Memcached clusters.</p> <note> <p>You cannot specify <code>single-az</code> if the Memcached cluster already has cache nodes in different Availability Zones. If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone.</p> <p>Only newly created nodes are located in different Availability Zones. </p> </note>"
31733191
},
31743192
"NewAvailabilityZones":{
31753193
"shape":"PreferredAvailabilityZoneList",
@@ -3222,6 +3240,14 @@
32223240
"CacheNodeType":{
32233241
"shape":"String",
32243242
"documentation":"<p>A valid cache node type that you want to scale this cluster up to.</p>"
3243+
},
3244+
"AuthToken":{
3245+
"shape":"String",
3246+
"documentation":"<p>Reserved parameter. The password used to access a password protected server. This parameter must be specified with the <code>auth-token-update</code> parameter. Password constraints:</p> <ul> <li> <p>Must be only printable ASCII characters</p> </li> <li> <p>Must be at least 16 characters and no more than 128 characters in length</p> </li> <li> <p>Cannot contain any of the following characters: '/', '\"', or '@', '%'</p> </li> </ul> <p> For more information, see AUTH password at <a href=\"http://redis.io/commands/AUTH\">AUTH</a>.</p>"
3247+
},
3248+
"AuthTokenUpdateStrategy":{
3249+
"shape":"AuthTokenUpdateStrategyType",
3250+
"documentation":"<p>Specifies the strategy to use to update the AUTH token. This parameter must be specified with the <code>auth-token</code> parameter. Possible values:</p> <ul> <li> <p>Rotate</p> </li> <li> <p>Set</p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a> </p>"
32253251
}
32263252
},
32273253
"documentation":"<p>Represents the input of a <code>ModifyCacheCluster</code> operation.</p>"
@@ -3299,6 +3325,11 @@
32993325
"shape":"BooleanOptional",
33003326
"documentation":"<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled): T1 node types.</p> </li> <li> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul>"
33013327
},
3328+
"NodeGroupId":{
3329+
"shape":"String",
3330+
"documentation":"<p>Deprecated. This parameter is not used.</p>",
3331+
"deprecated":true
3332+
},
33023333
"CacheSecurityGroupNames":{
33033334
"shape":"CacheSecurityGroupNameList",
33043335
"documentation":"<p>A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.</p> <p>This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).</p> <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be <code>Default</code>.</p>"
@@ -3347,10 +3378,13 @@
33473378
"shape":"String",
33483379
"documentation":"<p>A valid cache node type that you want to scale this replication group to.</p>"
33493380
},
3350-
"NodeGroupId":{
3381+
"AuthToken":{
33513382
"shape":"String",
3352-
"documentation":"<p>Deprecated. This parameter is not used.</p>",
3353-
"deprecated":true
3383+
"documentation":"<p>Reserved parameter. The password used to access a password protected server. This parameter must be specified with the <code>auth-token-update-strategy </code> parameter. Password constraints:</p> <ul> <li> <p>Must be only printable ASCII characters</p> </li> <li> <p>Must be at least 16 characters and no more than 128 characters in length</p> </li> <li> <p>Cannot contain any of the following characters: '/', '\"', or '@', '%'</p> </li> </ul> <p> For more information, see AUTH password at <a href=\"http://redis.io/commands/AUTH\">AUTH</a>.</p>"
3384+
},
3385+
"AuthTokenUpdateStrategy":{
3386+
"shape":"AuthTokenUpdateStrategyType",
3387+
"documentation":"<p>Specifies the strategy to use to update the AUTH token. This parameter must be specified with the <code>auth-token</code> parameter. Possible values:</p> <ul> <li> <p>Rotate</p> </li> <li> <p>Set</p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a> </p>"
33543388
}
33553389
},
33563390
"documentation":"<p>Represents the input of a <code>ModifyReplicationGroups</code> operation.</p>"
@@ -3822,6 +3856,10 @@
38223856
"CacheNodeType":{
38233857
"shape":"String",
38243858
"documentation":"<p>The cache node type that this cluster or replication group is scaled to.</p>"
3859+
},
3860+
"AuthTokenStatus":{
3861+
"shape":"AuthTokenUpdateStatus",
3862+
"documentation":"<p>The auth token status</p>"
38253863
}
38263864
},
38273865
"documentation":"<p>A group of settings that are applied to the cluster in the future, or that are currently being applied.</p>"
@@ -4021,6 +4059,10 @@
40214059
"shape":"BooleanOptional",
40224060
"documentation":"<p>A flag that enables using an <code>AuthToken</code> (password) when issuing Redis commands.</p> <p>Default: <code>false</code> </p>"
40234061
},
4062+
"AuthTokenLastModifiedDate":{
4063+
"shape":"TStamp",
4064+
"documentation":"<p>The date the auth token was last modified</p>"
4065+
},
40244066
"TransitEncryptionEnabled":{
40254067
"shape":"BooleanOptional",
40264068
"documentation":"<p>A flag that enables in-transit encryption when set to <code>true</code>.</p> <p>You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>"
@@ -4125,6 +4167,10 @@
41254167
"Resharding":{
41264168
"shape":"ReshardingStatus",
41274169
"documentation":"<p>The status of an online resharding operation.</p>"
4170+
},
4171+
"AuthTokenStatus":{
4172+
"shape":"AuthTokenUpdateStatus",
4173+
"documentation":"<p>The auth token status</p>"
41284174
}
41294175
},
41304176
"documentation":"<p>The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.</p>"

0 commit comments

Comments
 (0)