Skip to content

Commit

Permalink
docs(client-elasticache): Update to attributes of TestFailover and mi…
Browse files Browse the repository at this point in the history 
…nor revisions.
  • Loading branch information
awstools committed May 31, 2024
1 parent 59cc038 commit 4847ad6
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 13 deletions.
4 changes: 2 additions & 2 deletions clients/client-elasticache/src/commands/TestFailoverCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export interface TestFailoverCommandInput extends TestFailoverMessage {}
export interface TestFailoverCommandOutput extends TestFailoverResult, __MetadataBearer {}

/**
* <p>Represents the input of a <code>TestFailover</code> operation which test automatic
* <p>Represents the input of a <code>TestFailover</code> operation which tests 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
Expand All @@ -39,7 +39,7 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
* </p>
* <ul>
* <li>
* <p>A customer can use this operation to test automatic failover on up to 5 shards
* <p>A customer can use this operation to test automatic failover on up to 15 shards
* (called node groups in the ElastiCache API and Amazon CLI) in any rolling
* 24-hour period.</p>
* </li>
Expand Down
16 changes: 11 additions & 5 deletions clients/client-elasticache/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9927,7 +9927,7 @@ export interface DescribeUserGroupsResult {
/**
* <p>An optional marker returned from a prior request. Use this marker for pagination of
* results from this operation. If this parameter is specified, the response includes only
* records beyond the marker, up to the value specified by MaxRecords. ></p>
* records beyond the marker, up to the value specified by MaxRecords.></p>
* @public
*/
Marker?: string;
Expand Down Expand Up @@ -10727,10 +10727,13 @@ export interface ModifyCacheClusterMessage {
* specified with the <code>auth-token</code> parameter. Possible values:</p>
* <ul>
* <li>
* <p>Rotate</p>
* <p>ROTATE - default, if no update strategy is provided</p>
* </li>
* <li>
* <p>SET - allowed only after ROTATE</p>
* </li>
* <li>
* <p>Set</p>
* <p>DELETE - allowed only when transitioning to RBAC</p>
* </li>
* </ul>
* <p> For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html">Authenticating Users with Redis AUTH</a>
Expand Down Expand Up @@ -11213,10 +11216,13 @@ export interface ModifyReplicationGroupMessage {
* specified with the <code>auth-token</code> parameter. Possible values:</p>
* <ul>
* <li>
* <p>Rotate</p>
* <p>ROTATE - default, if no update strategy is provided</p>
* </li>
* <li>
* <p>SET - allowed only after ROTATE</p>
* </li>
* <li>
* <p>Set</p>
* <p>DELETE - allowed only when transitioning to RBAC</p>
* </li>
* </ul>
* <p> For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html">Authenticating Users with Redis AUTH</a>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ export interface TestFailoverMessage {

/**
* <p>The name of the node group (called shard in the console) in this replication group on
* which automatic failover is to be tested. You may test automatic failover on up to 5
* which automatic failover is to be tested. You may test automatic failover on up to 15
* node groups in any rolling 24-hour period.</p>
* @public
*/
Expand Down
10 changes: 5 additions & 5 deletions codegen/sdk-codegen/aws-models/elasticache.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9446,7 +9446,7 @@
"Marker": {
"target": "com.amazonaws.elasticache#String",
"traits": {
"smithy.api#documentation": "<p>An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. ></p>"
"smithy.api#documentation": "<p>An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.></p>"
}
}
},
Expand Down Expand Up @@ -11355,7 +11355,7 @@
"AuthTokenUpdateStrategy": {
"target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType",
"traits": {
"smithy.api#documentation": "<p>Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the <code>auth-token</code> parameter. Possible values:</p>\n <ul>\n <li>\n <p>Rotate</p>\n </li>\n <li>\n <p>Set</p>\n </li>\n </ul>\n <p> For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a>\n </p>"
"smithy.api#documentation": "<p>Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the <code>auth-token</code> parameter. Possible values:</p>\n <ul>\n <li>\n <p>ROTATE - default, if no update strategy is provided</p>\n </li>\n <li>\n <p>SET - allowed only after ROTATE</p>\n </li>\n <li>\n <p>DELETE - allowed only when transitioning to RBAC</p>\n </li>\n </ul>\n <p> For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a>\n </p>"
}
},
"LogDeliveryConfigurations": {
Expand Down Expand Up @@ -11926,7 +11926,7 @@
"AuthTokenUpdateStrategy": {
"target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType",
"traits": {
"smithy.api#documentation": "<p>Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the <code>auth-token</code> parameter. Possible values:</p>\n <ul>\n <li>\n <p>Rotate</p>\n </li>\n <li>\n <p>Set</p>\n </li>\n </ul>\n <p> For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a>\n </p>"
"smithy.api#documentation": "<p>Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the <code>auth-token</code> parameter. Possible values:</p>\n <ul>\n <li>\n <p>ROTATE - default, if no update strategy is provided</p>\n </li>\n <li>\n <p>SET - allowed only after ROTATE</p>\n </li>\n <li>\n <p>DELETE - allowed only when transitioning to RBAC</p>\n </li>\n </ul>\n <p> For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a>\n </p>"
}
},
"UserGroupIdsToAdd": {
Expand Down Expand Up @@ -15711,7 +15711,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Represents the input of a <code>TestFailover</code> operation which test automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).</p>\n <p>This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API. </p>\n <p class=\"title\">\n <b>Note the following</b>\n </p>\n <ul>\n <li>\n <p>A customer can use this operation to test automatic failover on up to 5 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.</p>\n </li>\n <li>\n <p>If calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.</p>\n <p> </p>\n </li>\n <li>\n <p>If calling this operation multiple times on different shards in the same Redis\n (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.</p>\n </li>\n <li>\n <p>To determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:</p>\n <ol>\n <li>\n <p>Replication group message: <code>Test Failover API called for node\n group <node-group-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Failover from primary node\n <primary-node-id> to replica node <node-id>\n completed</code>\n </p>\n </li>\n <li>\n <p>Replication group message: <code>Failover from primary node\n <primary-node-id> to replica node <node-id>\n completed</code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Recovering cache nodes\n <node-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Finished recovery for cache nodes\n <node-id></code>\n </p>\n </li>\n </ol>\n <p>For more information see:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing\n ElastiCache Events</a> in the <i>ElastiCache User\n Guide</i>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing\n Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>"
"smithy.api#documentation": "<p>Represents the input of a <code>TestFailover</code> operation which tests automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).</p>\n <p>This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API. </p>\n <p class=\"title\">\n <b>Note the following</b>\n </p>\n <ul>\n <li>\n <p>A customer can use this operation to test automatic failover on up to 15 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.</p>\n </li>\n <li>\n <p>If calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.</p>\n <p> </p>\n </li>\n <li>\n <p>If calling this operation multiple times on different shards in the same Redis\n (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.</p>\n </li>\n <li>\n <p>To determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:</p>\n <ol>\n <li>\n <p>Replication group message: <code>Test Failover API called for node\n group <node-group-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Failover from primary node\n <primary-node-id> to replica node <node-id>\n completed</code>\n </p>\n </li>\n <li>\n <p>Replication group message: <code>Failover from primary node\n <primary-node-id> to replica node <node-id>\n completed</code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Recovering cache nodes\n <node-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Finished recovery for cache nodes\n <node-id></code>\n </p>\n </li>\n </ol>\n <p>For more information see:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing\n ElastiCache Events</a> in the <i>ElastiCache User\n Guide</i>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p>\n </li>\n </ul>\n </li>\n </ul>\n <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing\n Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>"
}
},
"com.amazonaws.elasticache#TestFailoverMessage": {
Expand All @@ -15729,7 +15729,7 @@
"target": "com.amazonaws.elasticache#AllowedNodeGroupId",
"traits": {
"smithy.api#clientOptional": {},
"smithy.api#documentation": "<p>The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 5\n node groups in any rolling 24-hour period.</p>",
"smithy.api#documentation": "<p>The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 15\n node groups in any rolling 24-hour period.</p>",
"smithy.api#required": {}
}
}
Expand Down

0 comments on commit 4847ad6

Please sign in to comment.