[ aws . elasticache ]
test-migration
Description
Async API to test connection between source and target replication group.
See also: AWS API Documentation
Synopsis
test-migration
--replication-group-id <value>
--customer-node-endpoint-list <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options
--replication-group-id (string)
--customer-node-endpoint-list (list)
List of endpoints from which data should be migrated. List should have only one element.
(structure)
The endpoint from which data should be migrated.
Address -> (string)
Port -> (integer)
Shorthand Syntax:
Address=string,Port=integer ...
JSON Syntax:
[
{
"Address": "string",
"Port": integer
}
...
]
--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
ReplicationGroup -> (structure)
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId -> (string)
Description -> (string)
GlobalReplicationGroupInfo -> (structure)
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId -> (string)
GlobalReplicationGroupMemberRole -> (string)
Status -> (string)
creating , available , modifying , deleting , create-failed , snapshotting .PendingModifiedValues -> (structure)
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId -> (string)
--apply-immediately was specified), or during the next maintenance window.AutomaticFailoverStatus -> (string)
Resharding -> (structure)
The status of an online resharding operation.
SlotMigration -> (structure)
Represents the progress of an online resharding operation.
ProgressPercentage -> (double)
AuthTokenStatus -> (string)
UserGroups -> (structure)
The user group being modified.
UserGroupIdsToAdd -> (list)
The ID of the user group to add.
(string)
UserGroupIdsToRemove -> (list)
The ID of the user group to remove.
(string)
LogDeliveryConfigurations -> (list)
The log delivery configurations being modified
(structure)
The log delivery configurations being modified
LogType -> (string)
DestinationType -> (string)
DestinationDetails -> (structure)
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails -> (structure)
The configuration details of the CloudWatch Logs destination.
LogGroup -> (string)
KinesisFirehoseDetails -> (structure)
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream -> (string)
LogFormat -> (string)
TransitEncryptionEnabled -> (boolean)
TransitEncryptionMode -> (string)
ClusterMode -> (string)
MemberClusters -> (list)
The names of all the cache clusters that are part of this replication group.
(string)
NodeGroups -> (list)
A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
(structure)
Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
NodeGroupId -> (string)
Status -> (string)
creating , available , modifying , deleting .PrimaryEndpoint -> (structure)
The endpoint of the primary node in this node group (shard).
Address -> (string)
Port -> (integer)
ReaderEndpoint -> (structure)
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address -> (string)
Port -> (integer)
Slots -> (string)
NodeGroupMembers -> (list)
A list containing information about individual nodes within the node group (shard).
(structure)
Represents a single node within a node group (shard).
CacheClusterId -> (string)
CacheNodeId -> (string)
ReadEndpoint -> (structure)
The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.
Address -> (string)
Port -> (integer)
PreferredAvailabilityZone -> (string)
PreferredOutpostArn -> (string)
CurrentRole -> (string)
primary or replica . This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.SnapshottingClusterId -> (string)
AutomaticFailover -> (string)
MultiAZ -> (string)
ConfigurationEndpoint -> (structure)
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address -> (string)
Port -> (integer)
SnapshotRetentionLimit -> (integer)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Warning
If the value ofSnapshotRetentionLimit is set to zero (0), backups are turned off.SnapshotWindow -> (string)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
Note
This parameter is only valid if theEngine parameter is redis .ClusterEnabled -> (boolean)
A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
Valid values: true | false
CacheNodeType -> (string)
AuthTokenEnabled -> (boolean)
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate -> (timestamp)
TransitEncryptionEnabled -> (boolean)
A flag that enables in-transit encryption when set to true .
3.2.6 , 4.x or later.Default: false
AtRestEncryptionEnabled -> (boolean)
A flag that enables encryption at-rest when set to true .
You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
3.2.6 , 4.x or later.Default: false
MemberClustersOutpostArns -> (list)
The outpost ARNs of the replication group’s member clusters.
(string)
KmsKeyId -> (string)
ARN -> (string)
UserGroupIds -> (list)
The ID of the user group associated to the replication group.
(string)
LogDeliveryConfigurations -> (list)
Returns the destination, format and type of the logs.
(structure)
Returns the destination, format and type of the logs.
LogType -> (string)
DestinationType -> (string)
cloudwatch-logs or kinesis-firehose .DestinationDetails -> (structure)
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails -> (structure)
The configuration details of the CloudWatch Logs destination.
LogGroup -> (string)
KinesisFirehoseDetails -> (structure)
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream -> (string)
LogFormat -> (string)
Status -> (string)
enabling | disabling | modifying | active | error
Message -> (string)
ReplicationGroupCreateTime -> (timestamp)
DataTiering -> (string)
AutoMinorVersionUpgrade -> (boolean)
NetworkType -> (string)
ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system .IpDiscovery -> (string)
ipv4 | ipv6 . IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system .TransitEncryptionMode -> (string)
ClusterMode -> (string)
Engine -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.