@aws-sdk/client-elasticache 3.385.0 → 3.387.0

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

@@ -23,49 +23,63 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
 }
 /**
  * @public
- * <p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on
- *             a specified node group (called shard in the console) in a replication group (called cluster in the console).</p>
- *          <p>This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool
- *            for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. </p>
+ * <p>Represents the input of a <code>TestFailover</code> operation which test automatic
+ *             failover on a specified node group (called shard in the console) in a replication group
+ *             (called cluster in the console).</p>
+ *          <p>This API is designed for testing the behavior of your application in case of
+ *             ElastiCache failover. It is not designed to be an operational tool for initiating a
+ *             failover to overcome a problem you may have with the cluster. Moreover, in certain
+ *             conditions such as large-scale operational events, Amazon may block this API. </p>
  *          <p class="title">
  *             <b>Note the following</b>
  *          </p>
  *          <ul>
  *             <li>
- *                <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI)
- *                     in any rolling 24-hour period.</p>
+ *                <p>A customer can use this operation to test automatic failover on up to 5 shards
+ *                     (called node groups in the ElastiCache API and Amazon CLI) in any rolling
+ *                     24-hour period.</p>
  *             </li>
  *             <li>
- *                <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p>
+ *                <p>If calling this operation on shards in different clusters (called replication
+ *                     groups in the API and CLI), the calls can be made concurrently.</p>
  *                <p> </p>
  *             </li>
  *             <li>
- *                <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group,
- *                     the first node replacement must complete before a subsequent call can be made.</p>
+ *                <p>If calling this operation multiple times on different shards in the same Redis
+ *                     (cluster mode enabled) replication group, the first node replacement must
+ *                     complete before a subsequent call can be made.</p>
  *             </li>
  *             <li>
- *                <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,
- *                     the Amazon CLI, or the ElastiCache API.
- *                     Look for the following automatic failover related events, listed here in order of occurrance:</p>
+ *                <p>To determine whether the node replacement is complete you can check Events
+ *                     using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.
+ *                     Look for the following automatic failover related events, listed here in order
+ *                     of occurrance:</p>
  *                <ol>
  *                   <li>
- *                      <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code>
+ *                      <p>Replication group message: <code>Test Failover API called for node
+ *                                 group <node-group-id></code>
  *                      </p>
  *                   </li>
  *                   <li>
- *                      <p>Cache cluster message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
+ *                      <p>Cache cluster message: <code>Failover from primary node
+ *                                 <primary-node-id> to replica node <node-id>
+ *                                 completed</code>
  *                      </p>
  *                   </li>
  *                   <li>
- *                      <p>Replication group message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
+ *                      <p>Replication group message: <code>Failover from primary node
+ *                                 <primary-node-id> to replica node <node-id>
+ *                                 completed</code>
  *                      </p>
  *                   </li>
  *                   <li>
- *                      <p>Cache cluster message: <code>Recovering cache nodes <node-id></code>
+ *                      <p>Cache cluster message: <code>Recovering cache nodes
+ *                                 <node-id></code>
  *                      </p>
  *                   </li>
  *                   <li>
- *                      <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code>
+ *                      <p>Cache cluster message: <code>Finished recovery for cache nodes
+ *                                 <node-id></code>
  *                      </p>
  *                   </li>
  *                </ol>
@@ -73,8 +87,9 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
  *                <ul>
  *                   <li>
  *                      <p>
- *                         <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html">Viewing ElastiCache Events</a>
- *                             in the <i>ElastiCache User Guide</i>
+ *                         <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html">Viewing
+ *                                 ElastiCache Events</a> in the <i>ElastiCache User
+ *                                 Guide</i>
  *                      </p>
  *                   </li>
  *                   <li>
@@ -84,7 +99,8 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
  *                </ul>
  *             </li>
  *          </ul>
- *          <p>Also see, <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>
+ *          <p>Also see, <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test">Testing
+ *                 Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -248,7 +264,8 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
  *
  * @throws {@link NodeGroupNotFoundFault} (client fault)
  *  <p>The node group specified by the <code>NodeGroupId</code> parameter could not be found.
- *             Please verify that the node group exists and that you spelled the <code>NodeGroupId</code> value correctly.</p>
+ *             Please verify that the node group exists and that you spelled the
+ *                 <code>NodeGroupId</code> value correctly.</p>
  *
  * @throws {@link ReplicationGroupNotFoundFault} (client fault)
  *  <p>The specified replication group does not exist.</p>

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

@@ -0,0 +1,210 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient";
+import { TestMigrationMessage, TestMigrationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link TestMigrationCommand}.
+ */
+export interface TestMigrationCommandInput extends TestMigrationMessage {
+}
+/**
+ * @public
+ *
+ * The output of {@link TestMigrationCommand}.
+ */
+export interface TestMigrationCommandOutput extends TestMigrationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p> Async API to test connection between source and target replication group. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ElastiCacheClient, TestMigrationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import
+ * // const { ElastiCacheClient, TestMigrationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import
+ * const client = new ElastiCacheClient(config);
+ * const input = { // TestMigrationMessage
+ *   ReplicationGroupId: "STRING_VALUE", // required
+ *   CustomerNodeEndpointList: [ // CustomerNodeEndpointList // required
+ *     { // CustomerNodeEndpoint
+ *       Address: "STRING_VALUE",
+ *       Port: Number("int"),
+ *     },
+ *   ],
+ * };
+ * const command = new TestMigrationCommand(input);
+ * const response = await client.send(command);
+ * // { // TestMigrationResponse
+ * //   ReplicationGroup: { // ReplicationGroup
+ * //     ReplicationGroupId: "STRING_VALUE",
+ * //     Description: "STRING_VALUE",
+ * //     GlobalReplicationGroupInfo: { // GlobalReplicationGroupInfo
+ * //       GlobalReplicationGroupId: "STRING_VALUE",
+ * //       GlobalReplicationGroupMemberRole: "STRING_VALUE",
+ * //     },
+ * //     Status: "STRING_VALUE",
+ * //     PendingModifiedValues: { // ReplicationGroupPendingModifiedValues
+ * //       PrimaryClusterId: "STRING_VALUE",
+ * //       AutomaticFailoverStatus: "enabled" || "disabled",
+ * //       Resharding: { // ReshardingStatus
+ * //         SlotMigration: { // SlotMigration
+ * //           ProgressPercentage: Number("double"),
+ * //         },
+ * //       },
+ * //       AuthTokenStatus: "SETTING" || "ROTATING",
+ * //       UserGroups: { // UserGroupsUpdateStatus
+ * //         UserGroupIdsToAdd: [ // UserGroupIdList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         UserGroupIdsToRemove: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       LogDeliveryConfigurations: [ // PendingLogDeliveryConfigurationList
+ * //         { // PendingLogDeliveryConfiguration
+ * //           LogType: "slow-log" || "engine-log",
+ * //           DestinationType: "cloudwatch-logs" || "kinesis-firehose",
+ * //           DestinationDetails: { // DestinationDetails
+ * //             CloudWatchLogsDetails: { // CloudWatchLogsDestinationDetails
+ * //               LogGroup: "STRING_VALUE",
+ * //             },
+ * //             KinesisFirehoseDetails: { // KinesisFirehoseDestinationDetails
+ * //               DeliveryStream: "STRING_VALUE",
+ * //             },
+ * //           },
+ * //           LogFormat: "text" || "json",
+ * //         },
+ * //       ],
+ * //       TransitEncryptionEnabled: true || false,
+ * //       TransitEncryptionMode: "preferred" || "required",
+ * //       ClusterMode: "enabled" || "disabled" || "compatible",
+ * //     },
+ * //     MemberClusters: [ // ClusterIdList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     NodeGroups: [ // NodeGroupList
+ * //       { // NodeGroup
+ * //         NodeGroupId: "STRING_VALUE",
+ * //         Status: "STRING_VALUE",
+ * //         PrimaryEndpoint: { // Endpoint
+ * //           Address: "STRING_VALUE",
+ * //           Port: Number("int"),
+ * //         },
+ * //         ReaderEndpoint: {
+ * //           Address: "STRING_VALUE",
+ * //           Port: Number("int"),
+ * //         },
+ * //         Slots: "STRING_VALUE",
+ * //         NodeGroupMembers: [ // NodeGroupMemberList
+ * //           { // NodeGroupMember
+ * //             CacheClusterId: "STRING_VALUE",
+ * //             CacheNodeId: "STRING_VALUE",
+ * //             ReadEndpoint: {
+ * //               Address: "STRING_VALUE",
+ * //               Port: Number("int"),
+ * //             },
+ * //             PreferredAvailabilityZone: "STRING_VALUE",
+ * //             PreferredOutpostArn: "STRING_VALUE",
+ * //             CurrentRole: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     SnapshottingClusterId: "STRING_VALUE",
+ * //     AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
+ * //     MultiAZ: "enabled" || "disabled",
+ * //     ConfigurationEndpoint: "<Endpoint>",
+ * //     SnapshotRetentionLimit: Number("int"),
+ * //     SnapshotWindow: "STRING_VALUE",
+ * //     ClusterEnabled: true || false,
+ * //     CacheNodeType: "STRING_VALUE",
+ * //     AuthTokenEnabled: true || false,
+ * //     AuthTokenLastModifiedDate: new Date("TIMESTAMP"),
+ * //     TransitEncryptionEnabled: true || false,
+ * //     AtRestEncryptionEnabled: true || false,
+ * //     MemberClustersOutpostArns: [ // ReplicationGroupOutpostArnList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     KmsKeyId: "STRING_VALUE",
+ * //     ARN: "STRING_VALUE",
+ * //     UserGroupIds: [
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     LogDeliveryConfigurations: [ // LogDeliveryConfigurationList
+ * //       { // LogDeliveryConfiguration
+ * //         LogType: "slow-log" || "engine-log",
+ * //         DestinationType: "cloudwatch-logs" || "kinesis-firehose",
+ * //         DestinationDetails: {
+ * //           CloudWatchLogsDetails: {
+ * //             LogGroup: "STRING_VALUE",
+ * //           },
+ * //           KinesisFirehoseDetails: {
+ * //             DeliveryStream: "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         LogFormat: "text" || "json",
+ * //         Status: "active" || "enabling" || "modifying" || "disabling" || "error",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     ReplicationGroupCreateTime: new Date("TIMESTAMP"),
+ * //     DataTiering: "enabled" || "disabled",
+ * //     AutoMinorVersionUpgrade: true || false,
+ * //     NetworkType: "ipv4" || "ipv6" || "dual_stack",
+ * //     IpDiscovery: "ipv4" || "ipv6",
+ * //     TransitEncryptionMode: "preferred" || "required",
+ * //     ClusterMode: "enabled" || "disabled" || "compatible",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param TestMigrationCommandInput - {@link TestMigrationCommandInput}
+ * @returns {@link TestMigrationCommandOutput}
+ * @see {@link TestMigrationCommandInput} for command's `input` shape.
+ * @see {@link TestMigrationCommandOutput} for command's `response` shape.
+ * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  <p>The value for a parameter is invalid.</p>
+ *
+ * @throws {@link InvalidReplicationGroupStateFault} (client fault)
+ *  <p>The requested replication group is not in the <code>available</code> state.</p>
+ *
+ * @throws {@link ReplicationGroupAlreadyUnderMigrationFault} (client fault)
+ *  <p>The targeted replication group is not available. </p>
+ *
+ * @throws {@link ReplicationGroupNotFoundFault} (client fault)
+ *  <p>The specified replication group does not exist.</p>
+ *
+ * @throws {@link ElastiCacheServiceException}
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
+ *
+ */
+export declare class TestMigrationCommand extends $Command<TestMigrationCommandInput, TestMigrationCommandOutput, ElastiCacheClientResolvedConfig> {
+    readonly input: TestMigrationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: TestMigrationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ElastiCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TestMigrationCommandInput, TestMigrationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -63,3 +63,4 @@ export * from "./ResetCacheParameterGroupCommand";
 export * from "./RevokeCacheSecurityGroupIngressCommand";
 export * from "./StartMigrationCommand";
 export * from "./TestFailoverCommand";
+export * from "./TestMigrationCommand";

package/dist-types/index.d.ts

@@ -1,14 +1,14 @@
 /**
  * <fullname>Amazon ElastiCache</fullname>
- *          <p>Amazon ElastiCache is a web service that makes it easier to set up, operate,
- *             and scale a distributed cache in the cloud.</p>
- *          <p>With ElastiCache, customers get all of the benefits of a high-performance,
- *             in-memory cache with less of the administrative burden involved in launching and managing a distributed cache.
- *             The service makes setup, scaling,
- *             and cluster failure handling much simpler than in a self-managed cache deployment.</p>
- *          <p>In addition, through integration with Amazon CloudWatch,
- *             customers get enhanced visibility into the key performance statistics
- *             associated with their cache and can receive alarms if a part of their cache runs hot.</p>
+ *          <p>Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale
+ *             a distributed cache in the cloud.</p>
+ *          <p>With ElastiCache, customers get all of the benefits of a high-performance, in-memory
+ *             cache with less of the administrative burden involved in launching and managing a
+ *             distributed cache. The service makes setup, scaling, and cluster failure handling much
+ *             simpler than in a self-managed cache deployment.</p>
+ *          <p>In addition, through integration with Amazon CloudWatch, customers get enhanced
+ *             visibility into the key performance statistics associated with their cache and can
+ *             receive alarms if a part of their cache runs hot.</p>
  *
  * @packageDocumentation
  */