StartMigrationCommand

Suggest an Edit

Start the migration of data.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElastiCacheClient, StartMigrationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import
// const { ElastiCacheClient, StartMigrationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import
const client = new ElastiCacheClient(config);
const input = { // StartMigrationMessage
  ReplicationGroupId: "STRING_VALUE", // required
  CustomerNodeEndpointList: [ // CustomerNodeEndpointList // required
    { // CustomerNodeEndpoint
      Address: "STRING_VALUE",
      Port: Number("int"),
    },
  ],
};
const command = new StartMigrationCommand(input);
const response = await client.send(command);
// { // StartMigrationResponse
//   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",
//     Engine: "STRING_VALUE",
//   },
// };

StartMigrationCommand Input

See StartMigrationCommandInput for more details

Parameter
Type
Description
CustomerNodeEndpointList
Required
CustomerNodeEndpoint[] | undefined

List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element.

ReplicationGroupId
Required
string | undefined

The ID of the replication group to which data should be migrated.

StartMigrationCommand Output

See StartMigrationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ReplicationGroup
ReplicationGroup | undefined

Contains all of the attributes of a specific Valkey or Redis OSS replication group.

Throws

Name
Fault
Details
InvalidParameterValueException
client

The value for a parameter is invalid.

InvalidReplicationGroupStateFault
client

The requested replication group is not in the available state.

ReplicationGroupAlreadyUnderMigrationFault
client

The targeted replication group is not available.

ReplicationGroupNotFoundFault
client

The specified replication group does not exist.

ElastiCacheServiceException
Base exception class for all service exceptions from ElastiCache service.