Skip to content

Commit

Permalink
docs(client-elasticache): Renaming full service name as it appears in…
Browse files Browse the repository at this point in the history
… developer documentation.
  • Loading branch information
awstools committed Jul 29, 2024
1 parent de8d4a6 commit b5146ba
Show file tree
Hide file tree
Showing 33 changed files with 489 additions and 496 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
* <p>The requested replication group is not in the <code>available</code> state.</p>
*
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
* <p>The state of the serverless cache snapshot was not received. Available for Redis only.</p>
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link InvalidServerlessCacheStateFault} (client fault)
* <p>The account for these credentials is not currently active.</p>
Expand All @@ -112,7 +112,7 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
* <p>The serverless cache was not found or does not exist.</p>
*
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis only.</p>
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link SnapshotNotFoundFault} (client fault)
* <p>The requested snapshot name does not refer to an existing snapshot.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface CopyServerlessCacheSnapshotCommandOutput
__MetadataBearer {}

/**
* <p>Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.</p>
* <p>Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -83,16 +83,16 @@ export interface CopyServerlessCacheSnapshotCommandOutput
* <p>The value for a parameter is invalid.</p>
*
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
* <p>The state of the serverless cache snapshot was not received. Available for Redis only.</p>
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
* <p>A serverless cache snapshot with this name already exists. Available for Redis only.</p>
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis only.</p>
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServerlessCacheSnapshotQuotaExceededFault} (client fault)
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.</p>
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
* <p>The specified service linked role (SLR) was not found.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
/**
* <p>Makes a copy of an existing snapshot.</p>
* <note>
* <p>This operation is valid for Redis only.</p>
* <p>This operation is valid for Redis OSS only.</p>
* </note>
* <important>
* <p>Users or groups that have permissions to use the <code>CopySnapshot</code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul

/**
* <p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache
* engine software, either Memcached or Redis.</p>
* <p>This operation is not supported for Redis (cluster mode enabled) clusters.</p>
* engine software, either Memcached or Redis OSS.</p>
* <p>This operation is not supported for Redis OSS (cluster mode enabled) clusters.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ export interface CreateGlobalReplicationGroupCommandOutput
__MetadataBearer {}

/**
* <p>Global Datastore for Redis offers fully managed, fast, reliable and secure
* cross-region replication. Using Global Datastore for Redis, you can create cross-region
* read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster
* <p>Global Datastore for Redis OSS offers fully managed, fast, reliable and secure
* cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region
* read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster
* recovery across regions. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication
* Across Regions Using Global Datastore</a>. </p>
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ export interface CreateReplicationGroupCommandInput extends CreateReplicationGro
export interface CreateReplicationGroupCommandOutput extends CreateReplicationGroupResult, __MetadataBearer {}

/**
* <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication
* <p>Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication
* group.</p>
* <p>This API can be used to create a standalone regional replication group or a secondary
* replication group associated with a Global datastore.</p>
* <p>A Redis (cluster mode disabled) replication group is a collection of nodes, where
* <p>A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where
* one of the nodes is a read/write primary and the others are read-only replicas.
* Writes to the primary are asynchronously propagated to the replicas.</p>
* <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
* <p>A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
* node groups). Each shard has a primary node and up to 5 read-only replica nodes. The
* configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which
* is the maximum number or replicas allowed. </p>
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS
* engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node
* cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500
* shards (single primary and no replicas). Make sure there are enough available IP
Expand All @@ -50,14 +50,14 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
* <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
* choose the limit type <b>Nodes per cluster per instance
* type</b>. </p>
* <p>When a Redis (cluster mode disabled) replication group has been successfully created,
* <p>When a Redis OSS (cluster mode disabled) replication group has been successfully created,
* you can add one or more read replicas to it, up to a total of 5 read replicas. If you
* need to increase or decrease the number of node groups (console: shards), you can avail
* yourself of ElastiCache for Redis' scaling. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling
* ElastiCache for Redis Clusters</a> in the <i>ElastiCache User
* need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling.
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling
* ElastiCache (Redis OSS) Clusters</a> in the <i>ElastiCache User
* Guide</i>.</p>
* <note>
* <p>This operation is valid for Redis only.</p>
* <p>This operation is valid for Redis OSS only.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface CreateServerlessCacheSnapshotCommandOutput
__MetadataBearer {}

/**
* <p>This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.</p>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -92,10 +92,10 @@ export interface CreateServerlessCacheSnapshotCommandOutput
* <p>The serverless cache was not found or does not exist.</p>
*
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
* <p>A serverless cache snapshot with this name already exists. Available for Redis only.</p>
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServerlessCacheSnapshotQuotaExceededFault} (client fault)
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.</p>
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
* <p>The specified service linked role (SLR) was not found.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
* <p>Creates a copy of an entire cluster or replication group at a specific moment in
* time.</p>
* <note>
* <p>This operation is valid for Redis only.</p>
* <p>This operation is valid for Redis OSS only.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -141,12 +141,12 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
* <p>You attempted one of the following operations:</p>
* <ul>
* <li>
* <p>Creating a snapshot of a Redis cluster running on a
* <p>Creating a snapshot of a Redis OSS cluster running on a
* <code>cache.t1.micro</code> cache node.</p>
* </li>
* <li>
* <p>Creating a snapshot of a cluster that is running Memcached rather than
* Redis.</p>
* Redis OSS.</p>
* </li>
* </ul>
* <p>Neither of these are supported by ElastiCache.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface CreateUserCommandInput extends CreateUserMessage {}
export interface CreateUserCommandOutput extends User, __MetadataBearer {}

/**
* <p>For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see
* <p>For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see
* <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface CreateUserGroupCommandInput extends CreateUserGroupMessage {}
export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBearer {}

/**
* <p>For Redis engine version 6.0 onwards: Creates a Redis user group. For more
* <p>For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>
* </p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ export interface DecreaseReplicaCountCommandInput extends DecreaseReplicaCountMe
export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountResult, __MetadataBearer {}

/**
* <p>Dynamically decreases the number of replicas in a Redis (cluster mode disabled)
* <p>Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled)
* replication group or the number of replica nodes in one or more node groups (shards) of
* a Redis (cluster mode enabled) replication group. This operation is performed with no
* a Redis OSS (cluster mode enabled) replication group. This operation is performed with no
* cluster down time.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
* <p>This operation is not valid for:</p>
* <ul>
* <li>
* <p>Redis (cluster mode enabled) clusters</p>
* <p>Redis OSS (cluster mode enabled) clusters</p>
* </li>
* <li>
* <p>Redis (cluster mode disabled) clusters</p>
* <p>Redis OSS (cluster mode disabled) clusters</p>
* </li>
* <li>
* <p>A cluster that is the last read replica of a replication group</p>
Expand All @@ -50,7 +50,7 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
* <p>A node group (shard) that has Multi-AZ mode enabled</p>
* </li>
* <li>
* <p>A cluster from a Redis (cluster mode enabled) replication group</p>
* <p>A cluster from a Redis OSS (cluster mode enabled) replication group</p>
* </li>
* <li>
* <p>A cluster that is not in the <code>available</code> state</p>
Expand Down Expand Up @@ -210,12 +210,12 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
* <p>You attempted one of the following operations:</p>
* <ul>
* <li>
* <p>Creating a snapshot of a Redis cluster running on a
* <p>Creating a snapshot of a Redis OSS cluster running on a
* <code>cache.t1.micro</code> cache node.</p>
* </li>
* <li>
* <p>Creating a snapshot of a cluster that is running Memcached rather than
* Redis.</p>
* Redis OSS.</p>
* </li>
* </ul>
* <p>Neither of these are supported by ElastiCache.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
* immediately begins deleting the selected resources; you cannot cancel or revert this
* operation.</p>
* <note>
* <p>This operation is valid for Redis only.</p>
* <p>This operation is valid for Redis OSS only.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -202,12 +202,12 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
* <p>You attempted one of the following operations:</p>
* <ul>
* <li>
* <p>Creating a snapshot of a Redis cluster running on a
* <p>Creating a snapshot of a Redis OSS cluster running on a
* <code>cache.t1.micro</code> cache node.</p>
* </li>
* <li>
* <p>Creating a snapshot of a cluster that is running Memcached rather than
* Redis.</p>
* Redis OSS.</p>
* </li>
* </ul>
* <p>Neither of these are supported by ElastiCache.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export interface DeleteServerlessCacheCommandOutput extends DeleteServerlessCach
* <p>The serverless cache was not found or does not exist.</p>
*
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
* <p>A serverless cache snapshot with this name already exists. Available for Redis only.</p>
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
* <p>The specified service linked role (SLR) was not found.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface DeleteServerlessCacheSnapshotCommandOutput
__MetadataBearer {}

/**
* <p>Deletes an existing serverless cache snapshot. Available for Redis only.</p>
* <p>Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -75,10 +75,10 @@ export interface DeleteServerlessCacheSnapshotCommandOutput
* <p>The value for a parameter is invalid.</p>
*
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
* <p>The state of the serverless cache snapshot was not received. Available for Redis only.</p>
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis only.</p>
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
*
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
* <p>The specified service linked role (SLR) was not found.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met
* operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or
* revert this operation.</p>
* <note>
* <p>This operation is valid for Redis only.</p>
* <p>This operation is valid for Redis OSS only.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface DeleteUserCommandInput extends DeleteUserMessage {}
export interface DeleteUserCommandOutput extends User, __MetadataBearer {}

/**
* <p>For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from
* <p>For Redis OSS engine version 6.0 onwards: Deletes a user. The user will be removed from
* all user groups and in turn removed from all replication groups. For more information,
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface DeleteUserGroupCommandInput extends DeleteUserGroupMessage {}
export interface DeleteUserGroupCommandOutput extends UserGroup, __MetadataBearer {}

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

0 comments on commit b5146ba

Please sign in to comment.