@aws-sdk/client-elasticache 3.288.0 → 3.289.0

package/dist-types/commands/ModifyReplicationGroupCommand.d.ts

@@ -44,6 +44,80 @@ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGr
  * @see {@link ModifyReplicationGroupCommandOutput} for command's `response` shape.
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
  *
+ * @example ModifyReplicationGroup
+ * ```javascript
+ * //
+ * const input = {
+ *   "ApplyImmediately": true,
+ *   "ReplicationGroupDescription": "Modified replication group",
+ *   "ReplicationGroupId": "my-redis-rg",
+ *   "SnapshotRetentionLimit": 30,
+ *   "SnapshottingClusterId": "my-redis-rg-001"
+ * };
+ * const command = new ModifyReplicationGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ReplicationGroup": {
+ *     "AutomaticFailover": "enabled",
+ *     "Description": "Modified replication group",
+ *     "MemberClusters": [
+ *       "my-redis-rg-001",
+ *       "my-redis-rg-002",
+ *       "my-redis-rg-003"
+ *     ],
+ *     "NodeGroups": [
+ *       {
+ *         "NodeGroupId": "0001",
+ *         "NodeGroupMembers": [
+ *           {
+ *             "CacheClusterId": "my-redis-rg-001",
+ *             "CacheNodeId": "0001",
+ *             "CurrentRole": "primary",
+ *             "PreferredAvailabilityZone": "us-east-1b",
+ *             "ReadEndpoint": {
+ *               "Address": "my-redis-rg-001.abcdef.0001.use1.cache.amazonaws.com",
+ *               "Port": 6379
+ *             }
+ *           },
+ *           {
+ *             "CacheClusterId": "my-redis-rg-002",
+ *             "CacheNodeId": "0001",
+ *             "CurrentRole": "replica",
+ *             "PreferredAvailabilityZone": "us-east-1a",
+ *             "ReadEndpoint": {
+ *               "Address": "my-redis-rg-002.abcdef.0001.use1.cache.amazonaws.com",
+ *               "Port": 6379
+ *             }
+ *           },
+ *           {
+ *             "CacheClusterId": "my-redis-rg-003",
+ *             "CacheNodeId": "0001",
+ *             "CurrentRole": "replica",
+ *             "PreferredAvailabilityZone": "us-east-1c",
+ *             "ReadEndpoint": {
+ *               "Address": "my-redis-rg-003.abcdef.0001.use1.cache.amazonaws.com",
+ *               "Port": 6379
+ *             }
+ *           }
+ *         ],
+ *         "PrimaryEndpoint": {
+ *           "Address": "my-redis-rg.abcdef.ng.0001.use1.cache.amazonaws.com",
+ *           "Port": 6379
+ *         },
+ *         "Status": "available"
+ *       }
+ *     ],
+ *     "PendingModifiedValues": {},
+ *     "ReplicationGroupId": "my-redis-rg",
+ *     "SnapshottingClusterId": "my-redis-rg-002",
+ *     "Status": "available"
+ *   }
+ * }
+ * *\/
+ * // example id: modifyreplicationgroup-1483039689581
+ * ```
+ *
  */
 export declare class ModifyReplicationGroupCommand extends $Command<ModifyReplicationGroupCommandInput, ModifyReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
     readonly input: ModifyReplicationGroupCommandInput;

package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts

@@ -32,6 +32,17 @@ export interface PurchaseReservedCacheNodesOfferingCommandOutput extends Purchas
  * @see {@link PurchaseReservedCacheNodesOfferingCommandOutput} for command's `response` shape.
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
  *
+ * @example PurchaseReservedCacheNodesOfferings
+ * ```javascript
+ * // Allows you to purchase a reserved cache node offering.
+ * const input = {
+ *   "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a"
+ * };
+ * const command = new PurchaseReservedCacheNodesOfferingCommand(input);
+ * await client.send(command);
+ * // example id: purchasereservedcachenodesofferings-1483040798484
+ * ```
+ *
  */
 export declare class PurchaseReservedCacheNodesOfferingCommand extends $Command<PurchaseReservedCacheNodesOfferingCommandInput, PurchaseReservedCacheNodesOfferingCommandOutput, ElastiCacheClientResolvedConfig> {
     readonly input: PurchaseReservedCacheNodesOfferingCommandInput;

package/dist-types/commands/RebootCacheClusterCommand.d.ts

@@ -39,6 +39,50 @@ export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResul
  * @see {@link RebootCacheClusterCommandOutput} for command's `response` shape.
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
  *
+ * @example RebootCacheCluster
+ * ```javascript
+ * // Reboots the specified nodes in the names cluster.
+ * const input = {
+ *   "CacheClusterId": "custom-mem1-4  ",
+ *   "CacheNodeIdsToReboot": [
+ *     "0001",
+ *     "0002"
+ *   ]
+ * };
+ * const command = new RebootCacheClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CacheCluster": {
+ *     "AutoMinorVersionUpgrade": true,
+ *     "CacheClusterCreateTime": "2016-12-21T21:59:43.794Z",
+ *     "CacheClusterId": "my-mem-cluster",
+ *     "CacheClusterStatus": "rebooting cache cluster nodes",
+ *     "CacheNodeType": "cache.t2.medium",
+ *     "CacheParameterGroup": {
+ *       "CacheNodeIdsToReboot": [],
+ *       "CacheParameterGroupName": "default.memcached1.4",
+ *       "ParameterApplyStatus": "in-sync"
+ *     },
+ *     "CacheSecurityGroups": [],
+ *     "CacheSubnetGroupName": "default",
+ *     "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
+ *     "ConfigurationEndpoint": {
+ *       "Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com",
+ *       "Port": 11211
+ *     },
+ *     "Engine": "memcached",
+ *     "EngineVersion": "1.4.24",
+ *     "NumCacheNodes": 2,
+ *     "PendingModifiedValues": {},
+ *     "PreferredAvailabilityZone": "Multiple",
+ *     "PreferredMaintenanceWindow": "wed:06:00-wed:07:00"
+ *   }
+ * }
+ * *\/
+ * // example id: rebootcachecluster-1482969019505
+ * ```
+ *
  */
 export declare class RebootCacheClusterCommand extends $Command<RebootCacheClusterCommandInput, RebootCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
     readonly input: RebootCacheClusterCommandInput;

package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts

@@ -32,6 +32,48 @@ export interface RemoveTagsFromResourceCommandOutput extends TagListMessage, __M
  * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape.
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
  *
+ * @example RemoveTagsFromResource
+ * ```javascript
+ * // Removes tags identified by a list of tag keys from the list of tags on the specified resource.
+ * const input = {
+ *   "ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster",
+ *   "TagKeys": [
+ *     "A",
+ *     "C",
+ *     "E"
+ *   ]
+ * };
+ * const command = new RemoveTagsFromResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TagList": [
+ *     {
+ *       "Key": "B",
+ *       "Value": "Banana"
+ *     },
+ *     {
+ *       "Key": "D",
+ *       "Value": "Dog"
+ *     },
+ *     {
+ *       "Key": "F",
+ *       "Value": "Fox"
+ *     },
+ *     {
+ *       "Key": "I",
+ *       "Value": ""
+ *     },
+ *     {
+ *       "Key": "K",
+ *       "Value": "Kite"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: removetagsfromresource-1483037920947
+ * ```
+ *
  */
 export declare class RemoveTagsFromResourceCommand extends $Command<RemoveTagsFromResourceCommandInput, RemoveTagsFromResourceCommandOutput, ElastiCacheClientResolvedConfig> {
     readonly input: RemoveTagsFromResourceCommandInput;

package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts

@@ -32,6 +32,23 @@ export interface ResetCacheParameterGroupCommandOutput extends CacheParameterGro
  * @see {@link ResetCacheParameterGroupCommandOutput} for command's `response` shape.
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
  *
+ * @example ResetCacheParameterGroup
+ * ```javascript
+ * // Modifies the parameters of a cache parameter group to the engine or system default value.
+ * const input = {
+ *   "CacheParameterGroupName": "custom-mem1-4",
+ *   "ResetAllParameters": true
+ * };
+ * const command = new ResetCacheParameterGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CacheParameterGroupName": "custom-mem1-4"
+ * }
+ * *\/
+ * // example id: resetcacheparametergroup-1483038334014
+ * ```
+ *
  */
 export declare class ResetCacheParameterGroupCommand extends $Command<ResetCacheParameterGroupCommandInput, ResetCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
     readonly input: ResetCacheParameterGroupCommandInput;

package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts

@@ -31,6 +31,19 @@ export interface RevokeCacheSecurityGroupIngressCommandOutput extends RevokeCach
  * @see {@link RevokeCacheSecurityGroupIngressCommandOutput} for command's `response` shape.
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
  *
+ * @example DescribeCacheSecurityGroups
+ * ```javascript
+ * // Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.
+ * const input = {
+ *   "CacheSecurityGroupName": "my-sec-grp",
+ *   "EC2SecurityGroupName": "my-ec2-sec-grp",
+ *   "EC2SecurityGroupOwnerId": "1234567890"
+ * };
+ * const command = new RevokeCacheSecurityGroupIngressCommand(input);
+ * await client.send(command);
+ * // example id: describecachesecuritygroups-1483047200801
+ * ```
+ *
  */
 export declare class RevokeCacheSecurityGroupIngressCommand extends $Command<RevokeCacheSecurityGroupIngressCommandInput, RevokeCacheSecurityGroupIngressCommandOutput, ElastiCacheClientResolvedConfig> {
     readonly input: RevokeCacheSecurityGroupIngressCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-elasticache",
   "description": "AWS SDK for JavaScript Elasticache Client for Node.js, Browser and React Native",
-  "version": "3.288.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.288.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.288.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.288.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
-    "@aws-sdk/util-waiter": "3.272.0",
+    "@aws-sdk/util-waiter": "3.289.0",
     "fast-xml-parser": "4.1.2",
     "tslib": "^2.3.1"
   },