Skip to content

Commit b5146ba

Browse files
author
awstools
committed
docs(client-elasticache): Renaming full service name as it appears in developer documentation.
1 parent de8d4a6 commit b5146ba

33 files changed

+489
-496
lines changed

‎clients/client-elasticache/src/commands/AddTagsToResourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
9797
* <p>The requested replication group is not in the <code>available</code> state.</p>
9898
*
9999
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
100-
* <p>The state of the serverless cache snapshot was not received. Available for Redis only.</p>
100+
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
101101
*
102102
* @throws {@link InvalidServerlessCacheStateFault} (client fault)
103103
* <p>The account for these credentials is not currently active.</p>
@@ -112,7 +112,7 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
112112
* <p>The serverless cache was not found or does not exist.</p>
113113
*
114114
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
115-
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis only.</p>
115+
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
116116
*
117117
* @throws {@link SnapshotNotFoundFault} (client fault)
118118
* <p>The requested snapshot name does not refer to an existing snapshot.</p>

‎clients/client-elasticache/src/commands/CopyServerlessCacheSnapshotCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface CopyServerlessCacheSnapshotCommandOutput
3030
__MetadataBearer {}
3131

3232
/**
33-
* <p>Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.</p>
33+
* <p>Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript
@@ -83,16 +83,16 @@ export interface CopyServerlessCacheSnapshotCommandOutput
8383
* <p>The value for a parameter is invalid.</p>
8484
*
8585
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
86-
* <p>The state of the serverless cache snapshot was not received. Available for Redis only.</p>
86+
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
8787
*
8888
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
89-
* <p>A serverless cache snapshot with this name already exists. Available for Redis only.</p>
89+
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
9090
*
9191
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
92-
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis only.</p>
92+
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
9393
*
9494
* @throws {@link ServerlessCacheSnapshotQuotaExceededFault} (client fault)
95-
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.</p>
95+
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.</p>
9696
*
9797
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
9898
* <p>The specified service linked role (SLR) was not found.</p>

‎clients/client-elasticache/src/commands/CopySnapshotCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
3030
/**
3131
* <p>Makes a copy of an existing snapshot.</p>
3232
* <note>
33-
* <p>This operation is valid for Redis only.</p>
33+
* <p>This operation is valid for Redis OSS only.</p>
3434
* </note>
3535
* <important>
3636
* <p>Users or groups that have permissions to use the <code>CopySnapshot</code>

‎clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
2929

3030
/**
3131
* <p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache
32-
* engine software, either Memcached or Redis.</p>
33-
* <p>This operation is not supported for Redis (cluster mode enabled) clusters.</p>
32+
* engine software, either Memcached or Redis OSS.</p>
33+
* <p>This operation is not supported for Redis OSS (cluster mode enabled) clusters.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

‎clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ export interface CreateGlobalReplicationGroupCommandOutput
3030
__MetadataBearer {}
3131

3232
/**
33-
* <p>Global Datastore for Redis offers fully managed, fast, reliable and secure
34-
* cross-region replication. Using Global Datastore for Redis, you can create cross-region
35-
* read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster
33+
* <p>Global Datastore for Redis OSS offers fully managed, fast, reliable and secure
34+
* cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region
35+
* read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster
3636
* recovery across regions. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication
3737
* Across Regions Using Global Datastore</a>. </p>
3838
* <ul>

‎clients/client-elasticache/src/commands/CreateReplicationGroupCommand.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,18 @@ export interface CreateReplicationGroupCommandInput extends CreateReplicationGro
2828
export interface CreateReplicationGroupCommandOutput extends CreateReplicationGroupResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication
31+
* <p>Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication
3232
* group.</p>
3333
* <p>This API can be used to create a standalone regional replication group or a secondary
3434
* replication group associated with a Global datastore.</p>
35-
* <p>A Redis (cluster mode disabled) replication group is a collection of nodes, where
35+
* <p>A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where
3636
* one of the nodes is a read/write primary and the others are read-only replicas.
3737
* Writes to the primary are asynchronously propagated to the replicas.</p>
38-
* <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
38+
* <p>A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
3939
* node groups). Each shard has a primary node and up to 5 read-only replica nodes. The
4040
* configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which
4141
* is the maximum number or replicas allowed. </p>
42-
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis
42+
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS
4343
* engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node
4444
* cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500
4545
* shards (single primary and no replicas). Make sure there are enough available IP
@@ -50,14 +50,14 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
5050
* <p>To request a limit increase, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Service Limits</a> and
5151
* choose the limit type <b>Nodes per cluster per instance
5252
* type</b>. </p>
53-
* <p>When a Redis (cluster mode disabled) replication group has been successfully created,
53+
* <p>When a Redis OSS (cluster mode disabled) replication group has been successfully created,
5454
* you can add one or more read replicas to it, up to a total of 5 read replicas. If you
55-
* need to increase or decrease the number of node groups (console: shards), you can avail
56-
* yourself of ElastiCache for Redis' scaling. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling
57-
* ElastiCache for Redis Clusters</a> in the <i>ElastiCache User
55+
* need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling.
56+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling
57+
* ElastiCache (Redis OSS) Clusters</a> in the <i>ElastiCache User
5858
* Guide</i>.</p>
5959
* <note>
60-
* <p>This operation is valid for Redis only.</p>
60+
* <p>This operation is valid for Redis OSS only.</p>
6161
* </note>
6262
* @example
6363
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-elasticache/src/commands/CreateServerlessCacheSnapshotCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface CreateServerlessCacheSnapshotCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.</p>
36+
* <p>This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -92,10 +92,10 @@ export interface CreateServerlessCacheSnapshotCommandOutput
9292
* <p>The serverless cache was not found or does not exist.</p>
9393
*
9494
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
95-
* <p>A serverless cache snapshot with this name already exists. Available for Redis only.</p>
95+
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
9696
*
9797
* @throws {@link ServerlessCacheSnapshotQuotaExceededFault} (client fault)
98-
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.</p>
98+
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.</p>
9999
*
100100
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
101101
* <p>The specified service linked role (SLR) was not found.</p>

‎clients/client-elasticache/src/commands/CreateSnapshotCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
3131
* <p>Creates a copy of an entire cluster or replication group at a specific moment in
3232
* time.</p>
3333
* <note>
34-
* <p>This operation is valid for Redis only.</p>
34+
* <p>This operation is valid for Redis OSS only.</p>
3535
* </note>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
@@ -141,12 +141,12 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
141141
* <p>You attempted one of the following operations:</p>
142142
* <ul>
143143
* <li>
144-
* <p>Creating a snapshot of a Redis cluster running on a
144+
* <p>Creating a snapshot of a Redis OSS cluster running on a
145145
* <code>cache.t1.micro</code> cache node.</p>
146146
* </li>
147147
* <li>
148148
* <p>Creating a snapshot of a cluster that is running Memcached rather than
149-
* Redis.</p>
149+
* Redis OSS.</p>
150150
* </li>
151151
* </ul>
152152
* <p>Neither of these are supported by ElastiCache.</p>

‎clients/client-elasticache/src/commands/CreateUserCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateUserCommandInput extends CreateUserMessage {}
2828
export interface CreateUserCommandOutput extends User, __MetadataBearer {}
2929

3030
/**
31-
* <p>For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see
31+
* <p>For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see
3232
* <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-elasticache/src/commands/CreateUserGroupCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateUserGroupCommandInput extends CreateUserGroupMessage {}
2828
export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBearer {}
2929

3030
/**
31-
* <p>For Redis engine version 6.0 onwards: Creates a Redis user group. For more
31+
* <p>For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more
3232
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>
3333
* </p>
3434
* @example

‎clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ export interface DecreaseReplicaCountCommandInput extends DecreaseReplicaCountMe
2828
export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Dynamically decreases the number of replicas in a Redis (cluster mode disabled)
31+
* <p>Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled)
3232
* replication group or the number of replica nodes in one or more node groups (shards) of
33-
* a Redis (cluster mode enabled) replication group. This operation is performed with no
33+
* a Redis OSS (cluster mode enabled) replication group. This operation is performed with no
3434
* cluster down time.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-elasticache/src/commands/DeleteCacheClusterCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
3535
* <p>This operation is not valid for:</p>
3636
* <ul>
3737
* <li>
38-
* <p>Redis (cluster mode enabled) clusters</p>
38+
* <p>Redis OSS (cluster mode enabled) clusters</p>
3939
* </li>
4040
* <li>
41-
* <p>Redis (cluster mode disabled) clusters</p>
41+
* <p>Redis OSS (cluster mode disabled) clusters</p>
4242
* </li>
4343
* <li>
4444
* <p>A cluster that is the last read replica of a replication group</p>
@@ -50,7 +50,7 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
5050
* <p>A node group (shard) that has Multi-AZ mode enabled</p>
5151
* </li>
5252
* <li>
53-
* <p>A cluster from a Redis (cluster mode enabled) replication group</p>
53+
* <p>A cluster from a Redis OSS (cluster mode enabled) replication group</p>
5454
* </li>
5555
* <li>
5656
* <p>A cluster that is not in the <code>available</code> state</p>
@@ -210,12 +210,12 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
210210
* <p>You attempted one of the following operations:</p>
211211
* <ul>
212212
* <li>
213-
* <p>Creating a snapshot of a Redis cluster running on a
213+
* <p>Creating a snapshot of a Redis OSS cluster running on a
214214
* <code>cache.t1.micro</code> cache node.</p>
215215
* </li>
216216
* <li>
217217
* <p>Creating a snapshot of a cluster that is running Memcached rather than
218-
* Redis.</p>
218+
* Redis OSS.</p>
219219
* </li>
220220
* </ul>
221221
* <p>Neither of these are supported by ElastiCache.</p>

‎clients/client-elasticache/src/commands/DeleteReplicationGroupCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
3737
* immediately begins deleting the selected resources; you cannot cancel or revert this
3838
* operation.</p>
3939
* <note>
40-
* <p>This operation is valid for Redis only.</p>
40+
* <p>This operation is valid for Redis OSS only.</p>
4141
* </note>
4242
* @example
4343
* Use a bare-bones client and the command you need to make an API call.
@@ -202,12 +202,12 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
202202
* <p>You attempted one of the following operations:</p>
203203
* <ul>
204204
* <li>
205-
* <p>Creating a snapshot of a Redis cluster running on a
205+
* <p>Creating a snapshot of a Redis OSS cluster running on a
206206
* <code>cache.t1.micro</code> cache node.</p>
207207
* </li>
208208
* <li>
209209
* <p>Creating a snapshot of a cluster that is running Memcached rather than
210-
* Redis.</p>
210+
* Redis OSS.</p>
211211
* </li>
212212
* </ul>
213213
* <p>Neither of these are supported by ElastiCache.</p>

‎clients/client-elasticache/src/commands/DeleteServerlessCacheCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export interface DeleteServerlessCacheCommandOutput extends DeleteServerlessCach
107107
* <p>The serverless cache was not found or does not exist.</p>
108108
*
109109
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
110-
* <p>A serverless cache snapshot with this name already exists. Available for Redis only.</p>
110+
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
111111
*
112112
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
113113
* <p>The specified service linked role (SLR) was not found.</p>

‎clients/client-elasticache/src/commands/DeleteServerlessCacheSnapshotCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteServerlessCacheSnapshotCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Deletes an existing serverless cache snapshot. Available for Redis only.</p>
36+
* <p>Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -75,10 +75,10 @@ export interface DeleteServerlessCacheSnapshotCommandOutput
7575
* <p>The value for a parameter is invalid.</p>
7676
*
7777
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
78-
* <p>The state of the serverless cache snapshot was not received. Available for Redis only.</p>
78+
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
7979
*
8080
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
81-
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis only.</p>
81+
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
8282
*
8383
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
8484
* <p>The specified service linked role (SLR) was not found.</p>

‎clients/client-elasticache/src/commands/DeleteSnapshotCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met
3232
* operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or
3333
* revert this operation.</p>
3434
* <note>
35-
* <p>This operation is valid for Redis only.</p>
35+
* <p>This operation is valid for Redis OSS only.</p>
3636
* </note>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-elasticache/src/commands/DeleteUserCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteUserCommandInput extends DeleteUserMessage {}
2828
export interface DeleteUserCommandOutput extends User, __MetadataBearer {}
2929

3030
/**
31-
* <p>For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from
31+
* <p>For Redis OSS engine version 6.0 onwards: Deletes a user. The user will be removed from
3232
* all user groups and in turn removed from all replication groups. For more information,
3333
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
3434
* @example

‎clients/client-elasticache/src/commands/DeleteUserGroupCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteUserGroupCommandInput extends DeleteUserGroupMessage {}
2828
export interface DeleteUserGroupCommandOutput extends UserGroup, __MetadataBearer {}
2929

3030
/**
31-
* <p>For Redis engine version 6.0 onwards: Deletes a user group. The user group must first
31+
* <p>For Redis OSS engine version 6.0 onwards: Deletes a user group. The user group must first
3232
* be disassociated from the replication group before it can be deleted. For more
3333
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
3434
* @example

0 commit comments

Comments
 (0)