Skip to content

Commit

Permalink
feat(client-elasticache): Added support to modify the engine type for…
Browse files Browse the repository at this point in the history 
… existing ElastiCache Users and User Groups. Customers can now modify the engine type from redis to valkey.
  • Loading branch information
awstools committed Nov 21, 2024
1 parent 72fc499 commit 217c2b5
Show file tree
Hide file tree
Showing 27 changed files with 155 additions and 123 deletions.
4 changes: 2 additions & 2 deletions clients/client-elasticache/src/commands/AddTagsToResourceCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
* <p>A tag is a key-value pair where the key and value are case-sensitive. You can use tags
* to categorize and track all your ElastiCache resources, with the exception of global
* replication group. When you add or remove tags on replication groups, those actions will
* 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>
* 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>
* <p> For example, you can use cost-allocation tags to your ElastiCache resources, Amazon
* generates a cost allocation report as a comma-separated value (CSV) file with your usage
* and costs aggregated by your tags. You can apply tags that represent business categories
* (such as cost centers, application names, or owners) to organize your costs across
* multiple services.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html">Using Cost Allocation Tags in
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Tagging.html">Using Cost Allocation Tags in
* Amazon ElastiCache</a> in the <i>ElastiCache User
* Guide</i>.</p>
* @example
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/BatchApplyUpdateActionCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults

/**
* <p>Apply the service update. For more information on service updates and applying them,
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html">Applying Service
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/applying-updates.html">Applying Service
* Updates</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/BatchStopUpdateActionCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM

/**
* <p>Stop the service update. For more information on service updates and stopping them,
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html">Stopping
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/stopping-self-service-updates.html">Stopping
* Service Updates</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
16 changes: 8 additions & 8 deletions clients/client-elasticache/src/commands/CopySnapshotCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
* operation can create their own Amazon S3 buckets and copy snapshots to it. To
* control access to your snapshots, use an IAM policy to control who has the ability
* to use the <code>CopySnapshot</code> operation. For more information about using IAM
* to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html">Exporting
* Snapshots</a> and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html">Authentication & Access
* to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html">Exporting
* Snapshots</a> and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.html">Authentication & Access
* Control</a>.</p>
* </important>
* <p>You could receive the following error messages.</p>
Expand All @@ -52,7 +52,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
* the region.</p>
* <p>
* <b>Solution:</b> Create an Amazon S3 bucket in the
* 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
* 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
* Guide.</p>
* </li>
* <li>
Expand All @@ -61,7 +61,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
* exist.</p>
* <p>
* <b>Solution:</b> Create an Amazon S3 bucket in the
* 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
* 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
* Guide.</p>
* </li>
* <li>
Expand All @@ -70,7 +70,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
* by the authenticated user.</p>
* <p>
* <b>Solution:</b> Create an Amazon S3 bucket in the
* 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
* 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
* Guide.</p>
* </li>
* <li>
Expand All @@ -97,7 +97,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
* granted READ permissions %s on the S3 Bucket.</p>
* <p>
* <b>Solution:</b> Add List and Read permissions on
* 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
* 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
* ElastiCache User Guide.</p>
* </li>
* <li>
Expand All @@ -106,7 +106,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
* granted WRITE permissions %s on the S3 Bucket.</p>
* <p>
* <b>Solution:</b> Add Upload/Delete permissions on
* 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
* 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
* ElastiCache User Guide.</p>
* </li>
* <li>
Expand All @@ -115,7 +115,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
* granted READ_ACP permissions %s on the S3 Bucket.</p>
* <p>
* <b>Solution:</b> Add View Permissions on 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
* 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
* ElastiCache User Guide.</p>
* </li>
* </ul>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
*
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
* <p>The requested cache node type is not available in the specified Availability Zone. For
* 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>
* 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>
*
* @throws {@link InvalidParameterCombinationException} (client fault)
* <p>Two or more incompatible parameters were specified.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/CreateCacheParameterGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html">Parameters and
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ParameterGroups.html">Parameters and
* Parameter Groups</a> in the ElastiCache User Guide.</p>
* </li>
* </ul>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface CreateGlobalReplicationGroupCommandOutput
* <p>Global Datastore offers fully managed, fast, reliable and secure
* cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region
* read replica clusters for ElastiCache 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
* recovery across regions. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastore.html">Replication
* Across Regions Using Global Datastore</a>. </p>
* <ul>
* <li>
Expand Down
6 changes: 3 additions & 3 deletions clients/client-elasticache/src/commands/CreateReplicationGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
* shards (single primary and no replicas). Make sure there are enough available IP
* addresses to accommodate the increase. Common pitfalls include the subnets in the subnet
* group have too small a CIDR range or the subnets are shared and heavily used by other
* clusters. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html">Creating a Subnet
* clusters. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.Creating.html">Creating a Subnet
* Group</a>. For versions below 5.0.6, the limit is 250 per cluster.</p>
* <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 Valkey or 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 use scaling.
* 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
* 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
* Guide</i>.</p>
* <note>
* <p>This operation is valid for Valkey and Redis OSS only.</p>
Expand Down Expand Up @@ -307,7 +307,7 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
*
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
* <p>The requested cache node type is not available in the specified Availability Zone. For
* 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>
* 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>
*
* @throws {@link InvalidCacheClusterStateFault} (client fault)
* <p>The requested cluster is not in the <code>available</code> state.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/CreateUserCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface CreateUserCommandOutput extends User, __MetadataBearer {}

/**
* <p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a 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>
* <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/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.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/CreateUserGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBeare

/**
* <p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a 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>
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/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
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR
*
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
* <p>The requested cache node type is not available in the specified Availability Zone. For
* 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>
* 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>
*
* @throws {@link InvalidCacheClusterStateFault} (client fault)
* <p>The requested cluster is not in the <code>available</code> state.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/DeleteUserCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface DeleteUserCommandOutput extends User, __MetadataBearer {}
/**
* <p>For Valkey engine version 7.2 onwards and Redis OSS 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>
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/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.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/DeleteUserGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface DeleteUserGroupCommandOutput extends UserGroup, __MetadataBeare
/**
* <p>For Valkey engine version 7.2 onwards and Redis OSS 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>
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/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.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/IncreaseReplicaCountCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ export interface IncreaseReplicaCountCommandOutput extends IncreaseReplicaCountR
*
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
* <p>The requested cache node type is not available in the specified Availability Zone. For
* 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>
* 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>
*
* @throws {@link InvalidCacheClusterStateFault} (client fault)
* <p>The requested cluster is not in the <code>available</code> state.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-elasticache/src/commands/ListTagsForResourceCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
* tags to categorize and track all your ElastiCache resources, with the exception of
* global replication group. When you add or remove tags on replication groups, those
* actions will 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>
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
* <p>If the cluster is not in the <i>available</i> state,
* <code>ListTagsForResource</code> returns an error.</p>
* @example
Expand Down
Loading

0 comments on commit 217c2b5

Please sign in to comment.