AWS cli: ElastiCache start-migration: serverless cache migration options added
Summary
Updates the AWS CLI start-migration reference for a new API surface: adds --serverless-cache-name, --auto-cutover/--no-auto-cutover, and --clear-target-cache-data/--no-clear-target-cache-data parameters, relaxes previously required --replication-group-id and --customer-node-endpoint-list, and adds the full ServerlessCache response structure including KmsKeyId, StorageEncryptionType, SecurityGroupIds, NetworkType, ConnectionType and Migration details. Navigation links and CLI version bumped to 2.38.3.
Security assessment
This is a feature/API schema documentation refresh, not a fix for a specific vulnerability or incident. It does, however, document security-relevant settings introduced with serverless cache migration: at-rest encryption (KmsKeyId, StorageEncryptionType with sse-kms/sse-elasticache), SecurityGroupIds, and ConnectionType `vpc` | `public`, plus the destructive `--clear-target-cache-data` option that deletes existing target data. No CVE or advisory is referenced and no authz/credential handling changes appear.
Evidence
>> The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
Diff
diff --git a/cli/latest/reference/elasticache/start-migration.md b/cli/latest/reference/elasticache/start-migration.md index 6f0e0f2..6e9fb8c 100644 --- a//cli/latest/reference/elasticache/start-migration.md +++ b//cli/latest/reference/elasticache/start-migration.md @@ -13 +13 @@ - * [next](test-failover.html "test-failover") | + * [next](stop-migration.html "stop-migration") | @@ -15 +15 @@ - * [AWS CLI 2.38.2 Command Reference](../../index.html) » + * [AWS CLI 2.38.3 Command Reference](../../index.html) » @@ -23 +23 @@ - * [test-failover →](test-failover.html "next chapter \(use the right arrow\)") + * [stop-migration →](stop-migration.html "next chapter \(use the right arrow\)") @@ -60 +60 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Start the migration of data. +Starts the migration of data. @@ -68,2 +68,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elasti - --replication-group-id <value> - --customer-node-endpoint-list <value> + [--serverless-cache-name <value>] + [--replication-group-id <value>] + [--customer-node-endpoint-list <value>] + [--auto-cutover | --no-auto-cutover] + [--clear-target-cache-data | --no-clear-target-cache-data] @@ -95 +98,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elasti -`--replication-group-id` (string) [required] +`--serverless-cache-name` (string) + +> The name of the serverless cache to which data is being migrated. + +`--replication-group-id` (string) @@ -99 +106 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elasti -`--customer-node-endpoint-list` (list) [required] +`--customer-node-endpoint-list` (list) @@ -101 +108 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elasti -> List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element. +> The list of endpoints from which to migrate data. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element. For serverless cache migrations, ElastiCache uses the endpoint that you provided in `PrepareMigration` . @@ -132,0 +140,8 @@ JSON Syntax: +`--auto-cutover` | `--no-auto-cutover` (boolean) + +> Specifies whether ElastiCache automatically attempts to complete the migration after data sync is established. + +`--clear-target-cache-data` | `--no-clear-target-cache-data` (boolean) + +> Specifies whether ElastiCache deletes existing data in the serverless cache before migration begins. After `StopMigration` , `StartMigration` requires this option to restart the data sync. + @@ -925,0 +941,185 @@ ReplicationGroup -> (structure) +ServerlessCache -> (structure) + +> Provides the details of the serverless cache to which ElastiCache is migrating data. +> +> ServerlessCacheName -> (string) +> +>> The unique identifier of the serverless cache. +> +> Description -> (string) +> +>> A description of the serverless cache. +> +> CreateTime -> (timestamp) +> +>> When the serverless cache was created. +> +> Status -> (string) +> +>> The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING. +> +> Engine -> (string) +> +>> The engine the serverless cache is compatible with. +> +> MajorEngineVersion -> (string) +> +>> The version number of the engine the serverless cache is compatible with. +> +> FullEngineVersion -> (string) +> +>> The name and version number of the engine the serverless cache is compatible with. +> +> CacheUsageLimits -> (structure) +> +>> The cache usage limit for the serverless cache. +>> +>> DataStorage -> (structure) +>> +>>> The maximum data storage limit in the cache, expressed in Gigabytes. +>>> +>>> Maximum -> (integer) +>>> +>>>> The upper limit for data storage the cache is set to use. +>>> +>>> Minimum -> (integer) +>>> +>>>> The lower limit for data storage the cache is set to use. +>>> +>>> Unit -> (string) [required] +>>> +>>>> The unit that the storage is measured in, in GB. +>>>> +>>>> Possible values: +>>>> +>>>> * `GB` +>>>> + +>> +>> ECPUPerSecond -> (structure) +>> +>>> The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second. +>>> +>>> Maximum -> (integer) +>>> +>>>> The configuration for the maximum number of ECPUs the cache can consume per second. +>>> +>>> Minimum -> (integer) +>>> +>>>> The configuration for the minimum number of ECPUs the cache should be able consume per second. +> +> KmsKeyId -> (string) +> +>> The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache. +> +> StorageEncryptionType -> (string) +> +>> Indicates the type of encryption for data stored at rest in the serverless cache. Serverless caches are always encrypted at rest. The value is `sse-elasticache` if an ElastiCache service-managed key is used, or `sse-kms` if a customer-managed KMS key is used. +>> +>> Possible values: +>> +>> * `none` +>> * `sse-elasticache` +>> * `sse-kms` +>> + +> +> SecurityGroupIds -> (list) +> +>> The IDs of the EC2 security groups associated with the serverless cache. +>> +>> (string) +> +> Endpoint -> (structure) +> +>> Represents the information required for client programs to connect to a cache node. This value is read-only. +>> +>> Address -> (string) +>> +>>> The DNS hostname of the cache node. +>> +>> Port -> (integer) +>> +>>> The port number that the cache engine is listening on. +> +> ReaderEndpoint -> (structure) +> +>> Represents the information required for client programs to connect to a cache node. This value is read-only. +>> +>> Address -> (string) +>> +>>> The DNS hostname of the cache node. +>> +>> Port -> (integer) +>> +>>> The port number that the cache engine is listening on. +> +> ARN -> (string) +> +>> The Amazon Resource Name (ARN) of the serverless cache. +> +> UserGroupId -> (string) +> +>> The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL. +> +> SubnetIds -> (list) +> +>> If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC. +>> +>> (string) +> +> SnapshotRetentionLimit -> (integer) +> +>> The number of days for which ElastiCache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. The maximum value allowed is 35 days. +> +> DailySnapshotTime -> (string) +> +>> The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only. +> +> NetworkType -> (string) +> +>> The type of IP address protocol used by the serverless cache. Must be either `ipv4` | `ipv6` | `dual_stack` . `ipv6` is only supported with IPv6-only subnets. If not specified, defaults to `ipv4` , unless all provided subnets are IPv6-only, in which case it defaults to `ipv6` . +>> +>> Possible values: +>> +>> * `ipv4` +>> * `ipv6` +>> * `dual_stack` +>> + +> +> ConnectionType -> (string) +> +>> The connection type for the serverless cache. Must be either `vpc` | `public` . If not specified, defaults to `vpc` .