Skip to content

Commit b1ee23d

Browse files
author
AWS
committed
Amazon ElastiCache Update: Added support for cluster mode in online migration and test migration API
1 parent 1530a73 commit b1ee23d

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed
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": "Added support for cluster mode in online migration and test migration API"
6+
}

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

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1329,6 +1329,25 @@
13291329
{"shape":"InvalidParameterCombinationException"}
13301330
],
13311331
"documentation":"<p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).</p> <p>This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. </p> <p class=\"title\"> <b>Note the following</b> </p> <ul> <li> <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.</p> </li> <li> <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p> <p> </p> </li> <li> <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.</p> </li> <li> <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:</p> <ol> <li> <p>Replication group message: <code>Test Failover API called for node group &lt;node-group-id&gt;</code> </p> </li> <li> <p>Cache cluster message: <code>Failover from primary node &lt;primary-node-id&gt; to replica node &lt;node-id&gt; completed</code> </p> </li> <li> <p>Replication group message: <code>Failover from primary node &lt;primary-node-id&gt; to replica node &lt;node-id&gt; completed</code> </p> </li> <li> <p>Cache cluster message: <code>Recovering cache nodes &lt;node-id&gt;</code> </p> </li> <li> <p>Cache cluster message: <code>Finished recovery for cache nodes &lt;node-id&gt;</code> </p> </li> </ol> <p>For more information see:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing ElastiCache Events</a> in the <i>ElastiCache User Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p> </li> </ul> </li> </ul> <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>"
1332+
},
1333+
"TestMigration":{
1334+
"name":"TestMigration",
1335+
"http":{
1336+
"method":"POST",
1337+
"requestUri":"/"
1338+
},
1339+
"input":{"shape":"TestMigrationMessage"},
1340+
"output":{
1341+
"shape":"TestMigrationResponse",
1342+
"resultWrapper":"TestMigrationResult"
1343+
},
1344+
"errors":[
1345+
{"shape":"ReplicationGroupNotFoundFault"},
1346+
{"shape":"InvalidReplicationGroupStateFault"},
1347+
{"shape":"ReplicationGroupAlreadyUnderMigrationFault"},
1348+
{"shape":"InvalidParameterValueException"}
1349+
],
1350+
"documentation":"<p> Async API to test connection between source and target replication group. </p>"
13321351
}
13331352
},
13341353
"shapes":{
@@ -4137,7 +4156,7 @@
41374156
},
41384157
"NodeGroupCount":{
41394158
"shape":"Integer",
4140-
"documentation":"<p>The number of node groups you wish to add</p>"
4159+
"documentation":"<p>Total number of node groups you want</p>"
41414160
},
41424161
"RegionalConfigurations":{
41434162
"shape":"RegionalConfigurationList",
@@ -6711,6 +6730,29 @@
67116730
"ReplicationGroup":{"shape":"ReplicationGroup"}
67126731
}
67136732
},
6733+
"TestMigrationMessage":{
6734+
"type":"structure",
6735+
"required":[
6736+
"ReplicationGroupId",
6737+
"CustomerNodeEndpointList"
6738+
],
6739+
"members":{
6740+
"ReplicationGroupId":{
6741+
"shape":"String",
6742+
"documentation":"<p> The ID of the replication group to which data is to be migrated. </p>"
6743+
},
6744+
"CustomerNodeEndpointList":{
6745+
"shape":"CustomerNodeEndpointList",
6746+
"documentation":"<p> List of endpoints from which data should be migrated. List should have only one element. </p>"
6747+
}
6748+
}
6749+
},
6750+
"TestMigrationResponse":{
6751+
"type":"structure",
6752+
"members":{
6753+
"ReplicationGroup":{"shape":"ReplicationGroup"}
6754+
}
6755+
},
67146756
"TimeRangeFilter":{
67156757
"type":"structure",
67166758
"members":{

0 commit comments

Comments
 (0)