Skip to content

Commit 217c2b5

Browse files
author
awstools
committed
feat(client-elasticache): Added support to modify the engine type for existing ElastiCache Users and User Groups. Customers can now modify the engine type from redis to valkey.
1 parent 72fc499 commit 217c2b5

27 files changed

+155
-123
lines changed

Diff for: clients/client-elasticache/src/commands/AddTagsToResourceCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
3131
* <p>A tag is a key-value pair where the key and value are case-sensitive. You can use tags
3232
* to categorize and track all your ElastiCache resources, with the exception of global
3333
* replication group. When you add or remove tags on replication groups, those actions will
34-
* be replicated to all nodes in the replication group. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
34+
* be replicated to all nodes in the replication group. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
3535
* <p> For example, you can use cost-allocation tags to your ElastiCache resources, Amazon
3636
* generates a cost allocation report as a comma-separated value (CSV) file with your usage
3737
* and costs aggregated by your tags. You can apply tags that represent business categories
3838
* (such as cost centers, application names, or owners) to organize your costs across
3939
* multiple services.</p>
40-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html">Using Cost Allocation Tags in
40+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Tagging.html">Using Cost Allocation Tags in
4141
* Amazon ElastiCache</a> in the <i>ElastiCache User
4242
* Guide</i>.</p>
4343
* @example

Diff for: clients/client-elasticache/src/commands/BatchApplyUpdateActionCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults
2929

3030
/**
3131
* <p>Apply the service update. For more information on service updates and applying them,
32-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html">Applying Service
32+
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/applying-updates.html">Applying Service
3333
* Updates</a>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-elasticache/src/commands/BatchStopUpdateActionCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM
2929

3030
/**
3131
* <p>Stop the service update. For more information on service updates and stopping them,
32-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html">Stopping
32+
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/stopping-self-service-updates.html">Stopping
3333
* Service Updates</a>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-elasticache/src/commands/CopySnapshotCommand.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
3737
* operation can create their own Amazon S3 buckets and copy snapshots to it. To
3838
* control access to your snapshots, use an IAM policy to control who has the ability
3939
* to use the <code>CopySnapshot</code> operation. For more information about using IAM
40-
* to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html">Exporting
41-
* Snapshots</a> and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html">Authentication & Access
40+
* to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html">Exporting
41+
* Snapshots</a> and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.html">Authentication & Access
4242
* Control</a>.</p>
4343
* </important>
4444
* <p>You could receive the following error messages.</p>
@@ -52,7 +52,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
5252
* the region.</p>
5353
* <p>
5454
* <b>Solution:</b> Create an Amazon S3 bucket in the
55-
* same region as your snapshot. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User
55+
* same region as your snapshot. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User
5656
* Guide.</p>
5757
* </li>
5858
* <li>
@@ -61,7 +61,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
6161
* exist.</p>
6262
* <p>
6363
* <b>Solution:</b> Create an Amazon S3 bucket in the
64-
* same region as your snapshot. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User
64+
* same region as your snapshot. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User
6565
* Guide.</p>
6666
* </li>
6767
* <li>
@@ -70,7 +70,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
7070
* by the authenticated user.</p>
7171
* <p>
7272
* <b>Solution:</b> Create an Amazon S3 bucket in the
73-
* same region as your snapshot. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User
73+
* same region as your snapshot. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User
7474
* Guide.</p>
7575
* </li>
7676
* <li>
@@ -97,7 +97,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
9797
* granted READ permissions %s on the S3 Bucket.</p>
9898
* <p>
9999
* <b>Solution:</b> Add List and Read permissions on
100-
* the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the
100+
* the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the
101101
* ElastiCache User Guide.</p>
102102
* </li>
103103
* <li>
@@ -106,7 +106,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
106106
* granted WRITE permissions %s on the S3 Bucket.</p>
107107
* <p>
108108
* <b>Solution:</b> Add Upload/Delete permissions on
109-
* the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the
109+
* the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the
110110
* ElastiCache User Guide.</p>
111111
* </li>
112112
* <li>
@@ -115,7 +115,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
115115
* granted READ_ACP permissions %s on the S3 Bucket.</p>
116116
* <p>
117117
* <b>Solution:</b> Add View Permissions on the bucket.
118-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the
118+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the
119119
* ElastiCache User Guide.</p>
120120
* </li>
121121
* </ul>

Diff for: clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
245245
*
246246
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
247247
* <p>The requested cache node type is not available in the specified Availability Zone. For
248-
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
248+
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
249249
*
250250
* @throws {@link InvalidParameterCombinationException} (client fault)
251251
* <p>Two or more incompatible parameters were specified.</p>

Diff for: clients/client-elasticache/src/commands/CreateCacheParameterGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
4242
* </li>
4343
* <li>
4444
* <p>
45-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html">Parameters and
45+
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ParameterGroups.html">Parameters and
4646
* Parameter Groups</a> in the ElastiCache User Guide.</p>
4747
* </li>
4848
* </ul>

Diff for: clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface CreateGlobalReplicationGroupCommandOutput
3333
* <p>Global Datastore offers fully managed, fast, reliable and secure
3434
* cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region
3535
* read replica clusters for ElastiCache to enable low-latency reads and disaster
36-
* recovery across regions. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication
36+
* recovery across regions. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastore.html">Replication
3737
* Across Regions Using Global Datastore</a>. </p>
3838
* <ul>
3939
* <li>

Diff for: clients/client-elasticache/src/commands/CreateReplicationGroupCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
4545
* shards (single primary and no replicas). Make sure there are enough available IP
4646
* addresses to accommodate the increase. Common pitfalls include the subnets in the subnet
4747
* group have too small a CIDR range or the subnets are shared and heavily used by other
48-
* clusters. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html">Creating a Subnet
48+
* clusters. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.Creating.html">Creating a Subnet
4949
* Group</a>. For versions below 5.0.6, the limit is 250 per cluster.</p>
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>
5353
* <p>When a Valkey or 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
5555
* need to increase or decrease the number of node groups (console: shards), you can use scaling.
56-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling self-designed clusters</a> in the <i>ElastiCache User
56+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Scaling.html">Scaling self-designed clusters</a> in the <i>ElastiCache User
5757
* Guide</i>.</p>
5858
* <note>
5959
* <p>This operation is valid for Valkey and Redis OSS only.</p>
@@ -307,7 +307,7 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
307307
*
308308
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
309309
* <p>The requested cache node type is not available in the specified Availability Zone. For
310-
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
310+
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
311311
*
312312
* @throws {@link InvalidCacheClusterStateFault} (client fault)
313313
* <p>The requested cluster is not in the <code>available</code> state.</p>

Diff for: clients/client-elasticache/src/commands/CreateUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface CreateUserCommandOutput extends User, __MetadataBearer {}
2929

3030
/**
3131
* <p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see
32-
* <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>.</p>
32+
* <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/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.
3535
* ```javascript

Diff for: clients/client-elasticache/src/commands/CreateUserGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBeare
2929

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

Diff for: clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR
198198
*
199199
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
200200
* <p>The requested cache node type is not available in the specified Availability Zone. For
201-
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
201+
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
202202
*
203203
* @throws {@link InvalidCacheClusterStateFault} (client fault)
204204
* <p>The requested cluster is not in the <code>available</code> state.</p>

Diff for: clients/client-elasticache/src/commands/DeleteUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface DeleteUserCommandOutput extends User, __MetadataBearer {}
3030
/**
3131
* <p>For Valkey engine version 7.2 onwards and Redis OSS 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,
33-
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
33+
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

Diff for: clients/client-elasticache/src/commands/DeleteUserGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface DeleteUserGroupCommandOutput extends UserGroup, __MetadataBeare
3030
/**
3131
* <p>For Valkey engine version 7.2 onwards and Redis OSS 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
33-
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
33+
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

Diff for: clients/client-elasticache/src/commands/IncreaseReplicaCountCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ export interface IncreaseReplicaCountCommandOutput extends IncreaseReplicaCountR
195195
*
196196
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
197197
* <p>The requested cache node type is not available in the specified Availability Zone. For
198-
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
198+
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
199199
*
200200
* @throws {@link InvalidCacheClusterStateFault} (client fault)
201201
* <p>The requested cluster is not in the <code>available</code> state.</p>

Diff for: clients/client-elasticache/src/commands/ListTagsForResourceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
3333
* tags to categorize and track all your ElastiCache resources, with the exception of
3434
* global replication group. When you add or remove tags on replication groups, those
3535
* actions will be replicated to all nodes in the replication group. For more information,
36-
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
36+
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
3737
* <p>If the cluster is not in the <i>available</i> state,
3838
* <code>ListTagsForResource</code> returns an error.</p>
3939
* @example

0 commit comments

Comments
 (0)