Represents the input of a TestFailover operation which test automatic
+ *
Represents the input of a TestFailover operation which tests automatic
* failover on a specified node group (called shard in the console) in a replication group
* (called cluster in the console).
This API is designed for testing the behavior of your application in case of @@ -39,7 +39,7 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat *
*A customer can use this operation to test automatic failover on up to 5 shards + *
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.
*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. >
+ * records beyond the marker, up to the value specified by MaxRecords.> * @public */ Marker?: string; @@ -10727,10 +10727,13 @@ export interface ModifyCacheClusterMessage { * specified with theauth-token parameter. Possible values:
* Rotate
+ *ROTATE - default, if no update strategy is provided
+ *SET - allowed only after ROTATE
*Set
+ *DELETE - allowed only when transitioning to RBAC
* For more information, see Authenticating Users with Redis AUTH
@@ -11213,10 +11216,13 @@ export interface ModifyReplicationGroupMessage {
* specified with the auth-token parameter. Possible values:
Rotate
+ *ROTATE - default, if no update strategy is provided
+ *SET - allowed only after ROTATE
*Set
+ *DELETE - allowed only when transitioning to RBAC
*For more information, see Authenticating Users with Redis AUTH diff --git a/clients/client-elasticache/src/models/models_1.ts b/clients/client-elasticache/src/models/models_1.ts index fe977e60603f..e9b34381e55a 100644 --- a/clients/client-elasticache/src/models/models_1.ts +++ b/clients/client-elasticache/src/models/models_1.ts @@ -127,7 +127,7 @@ export interface TestFailoverMessage { /** *
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.
* @public */ diff --git a/codegen/sdk-codegen/aws-models/elasticache.json b/codegen/sdk-codegen/aws-models/elasticache.json index 5c30de76f793..93f2fa1a6439 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.json +++ b/codegen/sdk-codegen/aws-models/elasticache.json @@ -9446,7 +9446,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "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. >
" + "smithy.api#documentation": "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.>
" } } }, @@ -11355,7 +11355,7 @@ "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
Rotate
\nSet
\nFor more information, see Authenticating Users with Redis AUTH\n
" + "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
\nSET - allowed only after ROTATE
\nDELETE - allowed only when transitioning to RBAC
\nFor more information, see Authenticating Users with Redis AUTH\n
" } }, "LogDeliveryConfigurations": { @@ -11926,7 +11926,7 @@ "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
Rotate
\nSet
\nFor more information, see Authenticating Users with Redis AUTH\n
" + "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
\nSET - allowed only after ROTATE
\nDELETE - allowed only when transitioning to RBAC
\nFor more information, see Authenticating Users with Redis AUTH\n
" } }, "UserGroupIdsToAdd": { @@ -15711,7 +15711,7 @@ } ], "traits": { - "smithy.api#documentation": "Represents the input of a TestFailover 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).
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.
\n\n Note the following\n
\nA 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.
\nIf calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.
\n\n
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.
\nTo 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:
\nReplication group message: Test Failover API called for node\n group \n
Cache cluster message: Failover from primary node\n \n
Replication group message: Failover from primary node\n \n
Cache cluster message: Recovering cache nodes\n \n
Cache cluster message: Finished recovery for cache nodes\n \n
For more information see:
\n\n Viewing\n ElastiCache Events in the ElastiCache User\n Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing\n Multi-AZ in the ElastiCache User Guide.
" + "smithy.api#documentation": "Represents the input of a TestFailover 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).
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.
\n\n Note the following\n
\nA 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.
\nIf calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.
\n\n
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.
\nTo 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:
\nReplication group message: Test Failover API called for node\n group \n
Cache cluster message: Failover from primary node\n \n
Replication group message: Failover from primary node\n \n
Cache cluster message: Recovering cache nodes\n \n
Cache cluster message: Finished recovery for cache nodes\n \n
For more information see:
\n\n Viewing\n ElastiCache Events in the ElastiCache User\n Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing\n Multi-AZ in the ElastiCache User Guide.
" } }, "com.amazonaws.elasticache#TestFailoverMessage": { @@ -15729,7 +15729,7 @@ "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "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.
", "smithy.api#required": {} } }