# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [AuthorizeCacheSecurityGroupIngress](API_AuthorizeCacheSecurityGroupIngress.md) 
+  [BatchApplyUpdateAction](API_BatchApplyUpdateAction.md) 
+  [BatchStopUpdateAction](API_BatchStopUpdateAction.md) 
+  [CompleteMigration](API_CompleteMigration.md) 
+  [CopyServerlessCacheSnapshot](API_CopyServerlessCacheSnapshot.md) 
+  [CopySnapshot](API_CopySnapshot.md) 
+  [CreateCacheCluster](API_CreateCacheCluster.md) 
+  [CreateCacheParameterGroup](API_CreateCacheParameterGroup.md) 
+  [CreateCacheSecurityGroup](API_CreateCacheSecurityGroup.md) 
+  [CreateCacheSubnetGroup](API_CreateCacheSubnetGroup.md) 
+  [CreateGlobalReplicationGroup](API_CreateGlobalReplicationGroup.md) 
+  [CreateReplicationGroup](API_CreateReplicationGroup.md) 
+  [CreateServerlessCache](API_CreateServerlessCache.md) 
+  [CreateServerlessCacheSnapshot](API_CreateServerlessCacheSnapshot.md) 
+  [CreateSnapshot](API_CreateSnapshot.md) 
+  [CreateUser](API_CreateUser.md) 
+  [CreateUserGroup](API_CreateUserGroup.md) 
+  [DecreaseNodeGroupsInGlobalReplicationGroup](API_DecreaseNodeGroupsInGlobalReplicationGroup.md) 
+  [DecreaseReplicaCount](API_DecreaseReplicaCount.md) 
+  [DeleteCacheCluster](API_DeleteCacheCluster.md) 
+  [DeleteCacheParameterGroup](API_DeleteCacheParameterGroup.md) 
+  [DeleteCacheSecurityGroup](API_DeleteCacheSecurityGroup.md) 
+  [DeleteCacheSubnetGroup](API_DeleteCacheSubnetGroup.md) 
+  [DeleteGlobalReplicationGroup](API_DeleteGlobalReplicationGroup.md) 
+  [DeleteReplicationGroup](API_DeleteReplicationGroup.md) 
+  [DeleteServerlessCache](API_DeleteServerlessCache.md) 
+  [DeleteServerlessCacheSnapshot](API_DeleteServerlessCacheSnapshot.md) 
+  [DeleteSnapshot](API_DeleteSnapshot.md) 
+  [DeleteUser](API_DeleteUser.md) 
+  [DeleteUserGroup](API_DeleteUserGroup.md) 
+  [DescribeCacheClusters](API_DescribeCacheClusters.md) 
+  [DescribeCacheEngineVersions](API_DescribeCacheEngineVersions.md) 
+  [DescribeCacheParameterGroups](API_DescribeCacheParameterGroups.md) 
+  [DescribeCacheParameters](API_DescribeCacheParameters.md) 
+  [DescribeCacheSecurityGroups](API_DescribeCacheSecurityGroups.md) 
+  [DescribeCacheSubnetGroups](API_DescribeCacheSubnetGroups.md) 
+  [DescribeEngineDefaultParameters](API_DescribeEngineDefaultParameters.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeGlobalReplicationGroups](API_DescribeGlobalReplicationGroups.md) 
+  [DescribeReplicationGroups](API_DescribeReplicationGroups.md) 
+  [DescribeReservedCacheNodes](API_DescribeReservedCacheNodes.md) 
+  [DescribeReservedCacheNodesOfferings](API_DescribeReservedCacheNodesOfferings.md) 
+  [DescribeServerlessCaches](API_DescribeServerlessCaches.md) 
+  [DescribeServerlessCacheSnapshots](API_DescribeServerlessCacheSnapshots.md) 
+  [DescribeServiceUpdates](API_DescribeServiceUpdates.md) 
+  [DescribeSnapshots](API_DescribeSnapshots.md) 
+  [DescribeUpdateActions](API_DescribeUpdateActions.md) 
+  [DescribeUserGroups](API_DescribeUserGroups.md) 
+  [DescribeUsers](API_DescribeUsers.md) 
+  [DisassociateGlobalReplicationGroup](API_DisassociateGlobalReplicationGroup.md) 
+  [ExportServerlessCacheSnapshot](API_ExportServerlessCacheSnapshot.md) 
+  [FailoverGlobalReplicationGroup](API_FailoverGlobalReplicationGroup.md) 
+  [IncreaseNodeGroupsInGlobalReplicationGroup](API_IncreaseNodeGroupsInGlobalReplicationGroup.md) 
+  [IncreaseReplicaCount](API_IncreaseReplicaCount.md) 
+  [ListAllowedNodeTypeModifications](API_ListAllowedNodeTypeModifications.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyCacheCluster](API_ModifyCacheCluster.md) 
+  [ModifyCacheParameterGroup](API_ModifyCacheParameterGroup.md) 
+  [ModifyCacheSubnetGroup](API_ModifyCacheSubnetGroup.md) 
+  [ModifyGlobalReplicationGroup](API_ModifyGlobalReplicationGroup.md) 
+  [ModifyReplicationGroup](API_ModifyReplicationGroup.md) 
+  [ModifyReplicationGroupShardConfiguration](API_ModifyReplicationGroupShardConfiguration.md) 
+  [ModifyServerlessCache](API_ModifyServerlessCache.md) 
+  [ModifyUser](API_ModifyUser.md) 
+  [ModifyUserGroup](API_ModifyUserGroup.md) 
+  [PurchaseReservedCacheNodesOffering](API_PurchaseReservedCacheNodesOffering.md) 
+  [RebalanceSlotsInGlobalReplicationGroup](API_RebalanceSlotsInGlobalReplicationGroup.md) 
+  [RebootCacheCluster](API_RebootCacheCluster.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetCacheParameterGroup](API_ResetCacheParameterGroup.md) 
+  [RevokeCacheSecurityGroupIngress](API_RevokeCacheSecurityGroupIngress.md) 
+  [StartMigration](API_StartMigration.md) 
+  [TestFailover](API_TestFailover.md) 
+  [TestMigration](API_TestMigration.md) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see [Resource-level permissions](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html).

 For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.

For more information, see [Using Cost Allocation Tags in Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Tagging.html) in the *ElastiCache User Guide*.

## Request Parameters
<a name="API_AddTagsToResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceName **   
The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`. ElastiCache resources are *cluster* and *snapshot*.  
For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).  
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

## Response Elements
<a name="API_AddTagsToResource_ResponseElements"></a>

The following element is returned by the service.

 **TagList.Tag.N**   
A list of tags as key-value pairs.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_AddTagsToResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

 ** InvalidARN **   
The requested Amazon Resource Name (ARN) does not refer to an existing resource.  
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidServerlessCacheSnapshotStateFault **   
The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** InvalidServerlessCacheStateFault **   
The account for these credentials is not currently active.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** ReservedCacheNodeNotFound **   
The requested reserved cache node was not found.  
HTTP Status Code: 404

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServerlessCacheSnapshotNotFoundFault **   
This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 404

 ** SnapshotNotFoundFault **   
The requested snapshot name does not refer to an existing snapshot.  
HTTP Status Code: 404

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## Examples
<a name="API_AddTagsToResource_Examples"></a>

### AddTagsToResource
<a name="API_AddTagsToResource_Example_1"></a>

This example illustrates one usage of AddTagsToResource.

#### Sample Request
<a name="API_AddTagsToResource_Example_1_Request"></a>

```
https://elasticache.us-east-1.amazonaws.com/
   ?Action=AddTagsToResource
   &ResourceName=arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster 
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Tags.Tag.1.Key=Service
   &Tags.Tag.1.Value=elasticache
   &Tags.Tag.2.Key=Region
   &Tags.Tag.2.Value=us-west-2
   &Version=2015-02-02
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_AddTagsToResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/AddTagsToResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/AddTagsToResource) 

# AuthorizeCacheSecurityGroupIngress
<a name="API_AuthorizeCacheSecurityGroupIngress"></a>

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

**Note**  
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

## Request Parameters
<a name="API_AuthorizeCacheSecurityGroupIngress_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSecurityGroupName **   
The cache security group that allows network ingress.  
Type: String  
Required: Yes

 ** EC2SecurityGroupName **   
The Amazon EC2 security group to be authorized for ingress to the cache security group.  
Type: String  
Required: Yes

 ** EC2SecurityGroupOwnerId **   
The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.  
Type: String  
Required: Yes

## Response Elements
<a name="API_AuthorizeCacheSecurityGroupIngress_ResponseElements"></a>

The following element is returned by the service.

 ** CacheSecurityGroup **   
Represents the output of one of the following operations:  
+  `AuthorizeCacheSecurityGroupIngress` 
+  `CreateCacheSecurityGroup` 
+  `RevokeCacheSecurityGroupIngress` 
Type: [CacheSecurityGroup](API_CacheSecurityGroup.md) object

## Errors
<a name="API_AuthorizeCacheSecurityGroupIngress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationAlreadyExists **   
The specified Amazon EC2 security group is already authorized for the specified cache security group.  
HTTP Status Code: 400

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** InvalidCacheSecurityGroupState **   
The current state of the cache security group does not allow deletion.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_AuthorizeCacheSecurityGroupIngress_Examples"></a>

### AuthorizeCacheSecurityGroupIngress
<a name="API_AuthorizeCacheSecurityGroupIngress_Example_1"></a>

This example illustrates one usage of AuthorizeCacheSecurityGroupIngress.

#### Sample Request
<a name="API_AuthorizeCacheSecurityGroupIngress_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=AuthorizeCacheSecurityGroupIngress
   &EC2SecurityGroupName=default
   &CacheSecurityGroupName=mygroup
   &EC2SecurityGroupOwnerId=1234-5678-1234
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

### Example
<a name="API_AuthorizeCacheSecurityGroupIngress_Example_2"></a>

This example illustrates one usage of AuthorizeCacheSecurityGroupIngress.

#### Sample Response
<a name="API_AuthorizeCacheSecurityGroupIngress_Example_2_Response"></a>

```
<AuthorizeCacheSecurityGroupIngressResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
   <AuthorizeCacheSecurityGroupIngressResult>
      <CacheSecurityGroup>
         <EC2SecurityGroups>
            <EC2SecurityGroup>
               <Status>authorizing</Status>
               <EC2SecurityGroupName>default</EC2SecurityGroupName>
               <EC2SecurityGroupOwnerId>565419523791</EC2SecurityGroupOwnerId>
            </EC2SecurityGroup>
         </EC2SecurityGroups>
         <CacheSecurityGroupName>mygroup</CacheSecurityGroupName>
         <OwnerId>123456781234</OwnerId>
         <Description>My security group</Description>
      </CacheSecurityGroup>
   </AuthorizeCacheSecurityGroupIngress>
   <ResponseMetadata>
      <RequestId>817fa999-3647-11e0-ae57-f96cfe56749c</RequestId>
   </ResponseMetadata>
</AuthorizeCacheSecurityGroupIngressResponse>
```

## See Also
<a name="API_AuthorizeCacheSecurityGroupIngress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress) 

# BatchApplyUpdateAction
<a name="API_BatchApplyUpdateAction"></a>

Apply the service update. For more information on service updates and applying them, see [Applying Service Updates](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/applying-updates.html).

## Request Parameters
<a name="API_BatchApplyUpdateAction_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ServiceUpdateName **   
The unique ID of the service update  
Type: String  
Required: Yes

 **CacheClusterIds.member.N**   
The cache cluster IDs  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Required: No

 **ReplicationGroupIds.member.N**   
The replication group IDs  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Required: No

## Response Elements
<a name="API_BatchApplyUpdateAction_ResponseElements"></a>

The following elements are returned by the service.

 **ProcessedUpdateActions.ProcessedUpdateAction.N**   
Update actions that have been processed successfully  
Type: Array of [ProcessedUpdateAction](API_ProcessedUpdateAction.md) objects

 **UnprocessedUpdateActions.UnprocessedUpdateAction.N**   
Update actions that haven't been processed successfully  
Type: Array of [UnprocessedUpdateAction](API_UnprocessedUpdateAction.md) objects

## Errors
<a name="API_BatchApplyUpdateAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ServiceUpdateNotFoundFault **   
The service update doesn't exist  
HTTP Status Code: 404

## See Also
<a name="API_BatchApplyUpdateAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/BatchApplyUpdateAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/BatchApplyUpdateAction) 

# BatchStopUpdateAction
<a name="API_BatchStopUpdateAction"></a>

Stop the service update. For more information on service updates and stopping them, see [Stopping Service Updates](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/stopping-self-service-updates.html).

## Request Parameters
<a name="API_BatchStopUpdateAction_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ServiceUpdateName **   
The unique ID of the service update  
Type: String  
Required: Yes

 **CacheClusterIds.member.N**   
The cache cluster IDs  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Required: No

 **ReplicationGroupIds.member.N**   
The replication group IDs  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Required: No

## Response Elements
<a name="API_BatchStopUpdateAction_ResponseElements"></a>

The following elements are returned by the service.

 **ProcessedUpdateActions.ProcessedUpdateAction.N**   
Update actions that have been processed successfully  
Type: Array of [ProcessedUpdateAction](API_ProcessedUpdateAction.md) objects

 **UnprocessedUpdateActions.UnprocessedUpdateAction.N**   
Update actions that haven't been processed successfully  
Type: Array of [UnprocessedUpdateAction](API_UnprocessedUpdateAction.md) objects

## Errors
<a name="API_BatchStopUpdateAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ServiceUpdateNotFoundFault **   
The service update doesn't exist  
HTTP Status Code: 404

## See Also
<a name="API_BatchStopUpdateAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/BatchStopUpdateAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/BatchStopUpdateAction) 

# CompleteMigration
<a name="API_CompleteMigration"></a>

Complete the migration of data.

## Request Parameters
<a name="API_CompleteMigration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ReplicationGroupId **   
The ID of the replication group to which data is being migrated.  
Type: String  
Required: Yes

 ** Force **   
Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_CompleteMigration_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_CompleteMigration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** ReplicationGroupNotUnderMigrationFault **   
The designated replication group is not available for data migration.  
HTTP Status Code: 400

## See Also
<a name="API_CompleteMigration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CompleteMigration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CompleteMigration) 

# CopyServerlessCacheSnapshot
<a name="API_CopyServerlessCacheSnapshot"></a>

Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

## Request Parameters
<a name="API_CopyServerlessCacheSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceServerlessCacheSnapshotName **   
The identifier of the existing serverless cache’s snapshot to be copied. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: Yes

 ** TargetServerlessCacheSnapshotName **   
The identifier for the snapshot to be created. Available for Valkey, Redis OSS and Serverless Memcached only. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 ** KmsKeyId **   
The identifier of the KMS key used to encrypt the target snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CopyServerlessCacheSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** ServerlessCacheSnapshot **   
The response for the attempt to copy the serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: [ServerlessCacheSnapshot](API_ServerlessCacheSnapshot.md) object

## Errors
<a name="API_CopyServerlessCacheSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidServerlessCacheSnapshotStateFault **   
The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServerlessCacheSnapshotAlreadyExistsFault **   
A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServerlessCacheSnapshotNotFoundFault **   
This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 404

 ** ServerlessCacheSnapshotQuotaExceededFault **   
The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CopyServerlessCacheSnapshot_Examples"></a>

### CopyServerlessCacheSnapshot
<a name="API_CopyServerlessCacheSnapshot_Example_1"></a>

This example illustrates one usage of CopyServerlessCacheSnapshot.

#### Sample Request
<a name="API_CopyServerlessCacheSnapshot_Example_1_Request"></a>

```
{
    "input": {
        "SourceServerlessCacheSnapshotName": "my-serverless-cache-snapshot",
        "TargetServerlessCacheSnapshotName": "my-serverless-cache-snapshot-copy"
    },
    "output": {
        "ServerlessCacheSnapshot": {
            "ServerlessCacheSnapshotName": "my-serverless-cache-snapshot-copy",
            "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscachesnapshot:my-serverless-cache-snapshot-copy",
            "SnapshotType": "manual",
            "Status": "creating",
            "ServerlessCacheConfiguration": {
                "ServerlessCacheName": "my-serverless-cache",
                "Engine": "redis",
                "MajorEngineVersion": "7"
            }
        }
    }
}
```

## See Also
<a name="API_CopyServerlessCacheSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CopyServerlessCacheSnapshot) 

# CopySnapshot
<a name="API_CopySnapshot"></a>

Makes a copy of an existing snapshot.

**Note**  
This operation is valid for Valkey or Redis OSS only.

**Important**  
Users or groups that have permissions to use the `CopySnapshot` operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the `CopySnapshot` operation. For more information about using IAM to control the use of ElastiCache operations, see [Exporting Snapshots](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html) and [Authentication & Access Control](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.html).

You could receive the following error messages.

**Error Messages**
+  **Error Message:** The S3 bucket %s is outside of the region.

   **Solution:** Create an Amazon S3 bucket in the same region as your snapshot. For more information, see [Step 1: Create an Amazon S3 Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-create-s3-bucket) in the ElastiCache User Guide.
+  **Error Message:** The S3 bucket %s does not exist.

   **Solution:** Create an Amazon S3 bucket in the same region as your snapshot. For more information, see [Step 1: Create an Amazon S3 Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-create-s3-bucket) in the ElastiCache User Guide.
+  **Error Message:** The S3 bucket %s is not owned by the authenticated user.

   **Solution:** Create an Amazon S3 bucket in the same region as your snapshot. For more information, see [Step 1: Create an Amazon S3 Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-create-s3-bucket) in the ElastiCache User Guide.
+  **Error Message:** The authenticated user does not have sufficient permissions to perform the desired activity.

   **Solution:** Contact your system administrator to get the needed permissions.
+  **Error Message:** The S3 bucket %s already contains an object with key %s.

   **Solution:** Give the `TargetSnapshotName` a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for `TargetSnapshotName`.
+  **Error Message: ** ElastiCache has not been granted READ permissions %s on the S3 Bucket.

   **Solution:** Add List and Read permissions on the bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access) in the ElastiCache User Guide.
+  **Error Message: ** ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

   **Solution:** Add Upload/Delete permissions on the bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access) in the ElastiCache User Guide.
+  **Error Message: ** ElastiCache has not been granted READ\$1ACP permissions %s on the S3 Bucket.

   **Solution:** Add View Permissions on the bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access) in the ElastiCache User Guide.

## Request Parameters
<a name="API_CopySnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SourceSnapshotName **   
The name of an existing snapshot from which to make a copy.  
Type: String  
Required: Yes

 ** TargetSnapshotName **   
A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 ** KmsKeyId **   
The ID of the KMS key used to encrypt the target snapshot.  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TargetBucket **   
The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.  
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access) in the *Amazon ElastiCache User Guide*.  
For more information, see [Exporting a Snapshot](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html) in the *Amazon ElastiCache User Guide*.  
Type: String  
Required: No

## Response Elements
<a name="API_CopySnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** Snapshot **   
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_CopySnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidSnapshotState **   
The current state of the snapshot does not allow the requested operation to occur.  
HTTP Status Code: 400

 ** SnapshotAlreadyExistsFault **   
You already have a snapshot with the given name.  
HTTP Status Code: 400

 ** SnapshotNotFoundFault **   
The requested snapshot name does not refer to an existing snapshot.  
HTTP Status Code: 404

 ** SnapshotQuotaExceededFault **   
The request cannot be processed because it would exceed the maximum number of snapshots.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CopySnapshot_Examples"></a>

### Snapshot copy
<a name="API_CopySnapshot_Example_1"></a>

The following example makes a copy of the snapshot `automatic.my-redis-primary-2016-04-27-03-15` named `my-snapshot-copy`.

#### Sample Request
<a name="API_CopySnapshot_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
    ?Action=CopySnapshot
    &SourceSnapshotName=automatic.my-redis-primary-2016-04-27-03-15
    &TargetSnapshotName=my-snapshot-copy
    &SignatureVersion=4
    &SignatureMethod=HmacSHA256
    &Timestamp=20141201T220302Z
    &Version=2015-02-02
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Date=20141201T220302Z
    &X-Amz-SignedHeaders=Host
    &X-Amz-Expires=20141201T220302Z
    &X-Amz-Credential=<credential>
    &X-Amz-Signature=<signature>
```

## See Also
<a name="API_CopySnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CopySnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CopySnapshot) 

# CreateCacheCluster
<a name="API_CreateCacheCluster"></a>

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS.

This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

## Request Parameters
<a name="API_CreateCacheCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheClusterId **   
The node group (shard) identifier. This parameter is stored as a lowercase string.  
 **Constraints:**   
+ A name must contain from 1 to 50 alphanumeric characters or hyphens.
+ The first character must be a letter.
+ A name cannot end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: Yes

 ** AuthToken **   
 **Reserved parameter.** The password used to access a password protected server.  
Password constraints:  
+ Must be only printable ASCII characters.
+ Must be at least 16 characters and no more than 128 characters in length.
+ The only permitted printable special characters are \$1, &, \$1, \$1, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.  
Type: String  
Required: No

 ** AutoMinorVersionUpgrade **   
 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.    
Type: Boolean  
Required: No

 ** AZMode **   
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.  
This parameter is only supported for Memcached clusters.  
If the `AZMode` and `PreferredAvailabilityZones` are not specified, ElastiCache assumes `single-az` mode.  
Type: String  
Valid Values: `single-az | cross-az`   
Required: No

 ** CacheNodeType **   
The compute and memory capacity of the nodes in the node group (shard).  
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.  
+ General purpose:
  + Current generation: 

     **M7g node types**: `cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge` 

     **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge` 

     **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` 

     **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` 

     **T3 node types:** `cache.t3.micro`, `cache.t3.small`, `cache.t3.medium` 

     **T2 node types:** `cache.t2.micro`, `cache.t2.small`, `cache.t2.medium` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **T1 node types:** `cache.t1.micro` 

     **M1 node types:** `cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge` 

     **M3 node types:** `cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge` 
+ Compute optimized:
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **C1 node types:** `cache.c1.xlarge` 
+ Memory optimized:
  + Current generation: 

     **R7g node types**: `cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge` 

     **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge` 

     **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge` 

     **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` 
 **Additional node type info**   
+ All current generation instance types are created in Amazon VPC by default.
+ Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
+ Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
+ The configuration variables `appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
Type: String  
Required: No

 ** CacheParameterGroupName **   
The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has `cluster-enabled='yes'` when creating a cluster.  
Type: String  
Required: No

 **CacheSecurityGroupNames.CacheSecurityGroupName.N**   
A list of security group names to associate with this cluster.  
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).  
Type: Array of strings  
Required: No

 ** CacheSubnetGroupName **   
The name of the subnet group to be used for the cluster.  
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).  
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [Subnets and Subnet Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.html).
Type: String  
Required: No

 ** Engine **   
The name of the cache engine to be used for this cluster.  
Valid values for this parameter are: `memcached` \$1 `redis`   
Type: String  
Required: No

 ** EngineVersion **   
The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.  
 **Important:** You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement)), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.   
Type: String  
Required: No

 ** IpDiscovery **   
The network type you choose when modifying a cluster, either `ipv4` \$1 `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/).  
Type: String  
Valid Values: `ipv4 | ipv6`   
Required: No

 **LogDeliveryConfigurations.LogDeliveryConfigurationRequest.N**   
Specifies the destination, format and type of the logs.   
Type: Array of [LogDeliveryConfigurationRequest](API_LogDeliveryConfigurationRequest.md) objects  
Required: No

 ** NetworkType **   
Must be either `ipv4` \$1 `ipv6` \$1 `dual_stack`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/).   
Type: String  
Valid Values: `ipv4 | ipv6 | dual_stack`   
Required: No

 ** NotificationTopicArn **   
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.  
The Amazon SNS topic owner must be the same as the cluster owner.
Type: String  
Required: No

 ** NumCacheNodes **   
The initial number of cache nodes that the cluster has.  
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.  
If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at [http://aws.amazon.com/contact-us/elasticache-node-limit-request/](http://aws.amazon.com/contact-us/elasticache-node-limit-request/).  
Type: Integer  
Required: No

 ** OutpostMode **   
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.  
Type: String  
Valid Values: `single-outpost | cross-outpost`   
Required: No

 ** Port **   
The port number on which each of the cache nodes accepts connections.  
Type: Integer  
Required: No

 ** PreferredAvailabilityZone **   
The EC2 Availability Zone in which the cluster is created.  
All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use `PreferredAvailabilityZones`.  
Default: System chosen Availability Zone.  
Type: String  
Required: No

 **PreferredAvailabilityZones.PreferredAvailabilityZone.N**   
A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.  
This option is only supported on Memcached.  
If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.  
The number of Availability Zones listed must equal the value of `NumCacheNodes`.
If you want all the nodes in the same Availability Zone, use `PreferredAvailabilityZone` instead, or repeat the Availability Zone multiple times in the list.  
Default: System chosen Availability Zones.  
Type: Array of strings  
Required: No

 ** PreferredMaintenanceWindow **   
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.   
Type: String  
Required: No

 ** PreferredOutpostArn **   
The outpost ARN in which the cache cluster is created.  
Type: String  
Required: No

 **PreferredOutpostArns.PreferredOutpostArn.N**   
The outpost ARNs in which the cache cluster is created.  
Type: Array of strings  
Required: No

 ** ReplicationGroupId **   
The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.  
If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.  
This parameter is only valid if the `Engine` parameter is `redis`.
Type: String  
Required: No

 **SecurityGroupIds.SecurityGroupId.N**   
One or more VPC security groups associated with the cluster.  
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).  
Type: Array of strings  
Required: No

 **SnapshotArns.SnapshotArn.N**   
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.  
This parameter is only valid if the `Engine` parameter is `redis`.
Example of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb`   
Type: Array of strings  
Required: No

 ** SnapshotName **   
The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to `restoring` while the new node group (shard) is being created.  
This parameter is only valid if the `Engine` parameter is `redis`.
Type: String  
Required: No

 ** SnapshotRetentionLimit **   
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set `SnapshotRetentionLimit` to 5, a snapshot taken today is retained for 5 days before being deleted.  
This parameter is only valid if the `Engine` parameter is `redis`.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).  
Type: Integer  
Required: No

 ** SnapshotWindow **   
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.  
This parameter is only valid if the `Engine` parameter is `redis`.
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to this resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TransitEncryptionEnabled **   
A flag that enables in-transit encryption when set to true.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_CreateCacheCluster_ResponseElements"></a>

The following element is returned by the service.

 ** CacheCluster **   
Contains all of the attributes of a specific cluster.  
Type: [CacheCluster](API_CacheCluster.md) object

## Errors
<a name="API_CreateCacheCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterAlreadyExists **   
You already have a cluster with the given identifier.  
HTTP Status Code: 400

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

 ** ClusterQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of clusters per customer.  
HTTP Status Code: 400

 ** InsufficientCacheClusterCapacity **   
The requested cache node type is not available in the specified Availability Zone. For more information, see [InsufficientCacheClusterCapacity](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) in the ElastiCache User Guide.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The VPC network is in an invalid state.  
HTTP Status Code: 400

 ** NodeQuotaForClusterExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.  
HTTP Status Code: 400

 ** NodeQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CreateCacheCluster_Examples"></a>

### CreateCacheCluster
<a name="API_CreateCacheCluster_Example_1"></a>

This example illustrates one usage of CreateCacheCluster.

#### Sample Request
<a name="API_CreateCacheCluster_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
	?Action=CreateCacheCluster
	&CacheClusterId=myMemcachedCluster
	&CacheNodeType=cache.m1.small
	&CacheSecurityGroupNames.CacheSecurityGroupName.1=default
	&Engine=memcached
	&NumCacheNodes=3
	&PreferredAvailabilityZones.PreferredAvailabilityZone.1=us-west-2a
	&PreferredAvailabilityZones.PreferredAvailabilityZone.2=us-west-2b
	&PreferredAvailabilityZones.PreferredAvailabilityZone.3=us-west-2c
	&SignatureMethod=HmacSHA256
	&SignatureVersion=4
	&Version=2015-02-02
	&X-Amz-Algorithm=AWS4-HMAC-SHA256
	&X-Amz-Credential=[your-access-key-id]/20150202/us-west-2/elasticache/AWS4_request
	&X-Amz-Date=20150202T170651Z
	&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
	&X-Amz-Signature=[signature-value]
```

#### Sample Response
<a name="API_CreateCacheCluster_Example_1_Response"></a>

```
<CreateCacheClusterResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <CreateCacheClusterResult>
    <CacheCluster>
      <CacheClusterId>myMemcachedClustger</CacheClusterId>
      <CacheClusterStatus>creating</CacheClusterStatus>
      <CacheParameterGroup>
        <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>
        <ParameterApplyStatus>in-sync</ParameterApplyStatus>
        <CacheNodeIdsToReboot/>
      </CacheParameterGroup>
      <CacheNodeType>cache.m1.small</CacheNodeType>
      <Engine>memcached</Engine>
      <PendingModifiedValues/>
      <EngineVersion>1.4.14</EngineVersion>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <PreferredMaintenanceWindow>sat:09:00-sat:10:00</PreferredMaintenanceWindow>
      <ClientDownloadLandingPage>https://console.aws.amazon.com/elasticache/home#client-download:</ClientDownloadLandingPage>
      <CacheSecurityGroups>
        <CacheSecurityGroup>
          <CacheSecurityGroupName>default</CacheSecurityGroupName>
          <Status>active</Status>
        </CacheSecurityGroup>
      </CacheSecurityGroups>
      <NumCacheNodes>3</NumCacheNodes>
    </CacheCluster>
  </CreateCacheClusterResult>
  <ResponseMetadata>
    <RequestId>69134921-10f9-11e4-81bb-d76bad68b8fd</RequestId>
  </ResponseMetadata>
</CreateCacheClusterResponse>
```

## See Also
<a name="API_CreateCacheCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateCacheCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateCacheCluster) 

# CreateCacheParameterGroup
<a name="API_CreateCacheParameterGroup"></a>

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
+  [ModifyCacheParameterGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html) in the ElastiCache API Reference.
+  [Parameters and Parameter Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ParameterGroups.html) in the ElastiCache User Guide.

## Request Parameters
<a name="API_CreateCacheParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupFamily **   
The name of the cache parameter group family that the cache parameter group can be used with.  
Valid values are: `valkey8` \$1 `valkey7` \$1 `memcached1.4` \$1 `memcached1.5` \$1 `memcached1.6` \$1 `redis2.6` \$1 `redis2.8` \$1 `redis3.2` \$1 `redis4.0` \$1 `redis5.0` \$1 `redis6.x` \$1 `redis7`   
Type: String  
Required: Yes

 ** CacheParameterGroupName **   
A user-specified name for the cache parameter group. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 ** Description **   
A user-specified description for the cache parameter group.  
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateCacheParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** CacheParameterGroup **   
Represents the output of a `CreateCacheParameterGroup` operation.  
Type: [CacheParameterGroup](API_CacheParameterGroup.md) object

## Errors
<a name="API_CreateCacheParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheParameterGroupAlreadyExists **   
A cache parameter group with the requested name already exists.  
HTTP Status Code: 400

 ** CacheParameterGroupQuotaExceeded **   
The request cannot be processed because it would exceed the maximum number of cache security groups.  
HTTP Status Code: 400

 ** InvalidCacheParameterGroupState **   
The current state of the cache parameter group does not allow the requested operation to occur.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CreateCacheParameterGroup_Examples"></a>

### CreateCacheParameterGroup
<a name="API_CreateCacheParameterGroup_Example_1"></a>

This example illustrates one usage of CreateCacheParameterGroup.

#### Sample Request
<a name="API_CreateCacheParameterGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=CreateCacheParameterGroup
   &CacheParameterGroupFamily=memcached1.4
   &CacheParameterGroupName=mycacheparametergroup1
   &Description=My%20custom%20Redis%20cache%20parameter%20group
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &Version=2015-02-02
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_CreateCacheParameterGroup_Example_1_Response"></a>

```
<CreateCacheParameterGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <CreateCacheParameterGroupResult>
    <CacheParameterGroup>
      <CacheParameterGroupName>mycacheparametergroup1</CacheParameterGroupName>
      <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
      <Description>My first cache parameter group</Description>
    </CacheParameterGroup>
  </CreateCacheParameterGroupResult>
  <ResponseMetadata>
    <RequestId>05699541-b7f9-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</CreateCacheParameterGroupResponse>
```

## See Also
<a name="API_CreateCacheParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateCacheParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateCacheParameterGroup) 

# CreateCacheSecurityGroup
<a name="API_CreateCacheSecurityGroup"></a>

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see [CreateCacheSubnetGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html).

## Request Parameters
<a name="API_CreateCacheSecurityGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSecurityGroupName **   
A name for the cache security group. This value is stored as a lowercase string.  
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".  
Example: `mysecuritygroup`   
Type: String  
Required: Yes

 ** Description **   
A description for the cache security group.  
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateCacheSecurityGroup_ResponseElements"></a>

The following element is returned by the service.

 ** CacheSecurityGroup **   
Represents the output of one of the following operations:  
+  `AuthorizeCacheSecurityGroupIngress` 
+  `CreateCacheSecurityGroup` 
+  `RevokeCacheSecurityGroupIngress` 
Type: [CacheSecurityGroup](API_CacheSecurityGroup.md) object

## Errors
<a name="API_CreateCacheSecurityGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheSecurityGroupAlreadyExists **   
A cache security group with the specified name already exists.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** QuotaExceeded.CacheSecurityGroup **   
The request cannot be processed because it would exceed the allowed number of cache security groups.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CreateCacheSecurityGroup_Examples"></a>

### CreateCacheSecurityGroup
<a name="API_CreateCacheSecurityGroup_Example_1"></a>

This example illustrates one usage of CreateCacheSecurityGroup.

#### Sample Request
<a name="API_CreateCacheSecurityGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=CreateCacheSecurityGroup
   &CacheSecurityGroupName=mycachesecuritygroup
   &Description=My%20cache%20security%20group
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_CreateCacheSecurityGroup_Example_1_Response"></a>

```
<CreateCacheSecurityGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
   <CreateCacheSecurityGroupResult>
      <CacheSecurityGroup>
         <EC2SecurityGroups/>
         <CacheSecurityGroupName>mycachesecuritygroup</CacheSecurityGroupName>
         <OwnerId>123456789012</OwnerId>
         <Description>My cache security group</Description>
      </CacheSecurityGroup>
   </CreateCacheSecurityGroupResult>
   <ResponseMetadata>
      <RequestId>2b1c8035-b7fa-11e0-9326-b7275b9d4a6c</RequestId>
   </ResponseMetadata>
</CreateCacheSecurityGroupResponse>
```

## See Also
<a name="API_CreateCacheSecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateCacheSecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateCacheSecurityGroup) 

# CreateCacheSubnetGroup
<a name="API_CreateCacheSubnetGroup"></a>

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

## Request Parameters
<a name="API_CreateCacheSubnetGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSubnetGroupDescription **   
A description for the cache subnet group.  
Type: String  
Required: Yes

 ** CacheSubnetGroupName **   
A name for the cache subnet group. This value is stored as a lowercase string.  
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.  
Example: `mysubnetgroup`   
Type: String  
Required: Yes

 **SubnetIds.SubnetIdentifier.N**   
A list of VPC subnet IDs for the cache subnet group.  
Type: Array of strings  
Required: Yes

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateCacheSubnetGroup_ResponseElements"></a>

The following element is returned by the service.

 ** CacheSubnetGroup **   
Represents the output of one of the following operations:  
+  `CreateCacheSubnetGroup` 
+  `ModifyCacheSubnetGroup` 
Type: [CacheSubnetGroup](API_CacheSubnetGroup.md) object

## Errors
<a name="API_CreateCacheSubnetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheSubnetGroupAlreadyExists **   
The requested cache subnet group name is already in use by an existing cache subnet group.  
HTTP Status Code: 400

 ** CacheSubnetGroupQuotaExceeded **   
The request cannot be processed because it would exceed the allowed number of cache subnet groups.  
HTTP Status Code: 400

 ** CacheSubnetQuotaExceededFault **   
The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.  
HTTP Status Code: 400

 ** InvalidSubnet **   
An invalid subnet identifier was specified.  
HTTP Status Code: 400

 ** SubnetNotAllowedFault **   
At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CreateCacheSubnetGroup_Examples"></a>

### CreateCacheSubnetGroup
<a name="API_CreateCacheSubnetGroup_Example_1"></a>

This example illustrates one usage of CreateCacheSubnetGroup.

#### Sample Request
<a name="API_CreateCacheSubnetGroup_Example_1_Request"></a>

```
https://elasticache.amazonaws.com/
   ?Action=CreateCacheSubnetGroup
   &CacheSubnetGroupName=myCachesubnetgroup
   &CacheSubnetGroupDescription=My%20new%20CacheSubnetGroup
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_CreateCacheSubnetGroup_Example_1_Response"></a>

```
<CreateCacheSubnetGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
   <CreateCacheSubnetGroupResult>
      <CacheSubnetGroup>
         <VpcId>990524496922</VpcId>
            <CacheSubnetGroupDescription>My new CacheSubnetGroup</CacheSubnetGroupDescription>
            <CacheSubnetGroupName>myCachesubnetgroup</CacheSubnetGroupName>
            <Subnets>
               <Subnet>
                  <SubnetStatus>Active</SubnetStatus>
                  <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>
                  <SubnetAvailabilityZone>
                     <Name>us-west-2c</Name>
                  </SubnetAvailabilityZone>
               </Subnet>
               <Subnet>
                  <SubnetStatus>Active</SubnetStatus>
                  <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>
                  <SubnetAvailabilityZone>
                     <Name>us-west-2b</Name>
                  </SubnetAvailabilityZone>
               </Subnet>
               <Subnet>
                  <SubnetStatus>Active</SubnetStatus>
                  <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>
                  <SubnetAvailabilityZone>
                     <Name>us-west-2c</Name>
                  </SubnetAvailabilityZone>
               </Subnet>
            </Subnets>
         </CacheSubnetGroup>
      </CreateCacheSubnetGroupResult>
      <ResponseMetadata>
         <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>
      </ResponseMetadata>
   </CreateCacheSubnetGroupResponse>
```

## See Also
<a name="API_CreateCacheSubnetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateCacheSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateCacheSubnetGroup) 

# CreateGlobalReplicationGroup
<a name="API_CreateGlobalReplicationGroup"></a>

Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache to enable low-latency reads and disaster recovery across regions. For more information, see [Replication Across Regions Using Global Datastore](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastore.html). 
+ The **GlobalReplicationGroupIdSuffix** is the name of the Global datastore.
+ The **PrimaryReplicationGroupId** represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

## Request Parameters
<a name="API_CreateGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalReplicationGroupIdSuffix **   
The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.   
For a full list of Amazon Regions and their respective Global datastore iD prefixes, see [Using the Amazon CLI with Global datastores ](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastores-CLI.html).  
Type: String  
Required: Yes

 ** PrimaryReplicationGroupId **   
The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 ** GlobalReplicationGroupDescription **   
Provides details of the Global datastore  
Type: String  
Required: No

## Response Elements
<a name="API_CreateGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_CreateGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupAlreadyExistsFault **   
The Global datastore name already exists.  
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

## See Also
<a name="API_CreateGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateGlobalReplicationGroup) 

# CreateReplicationGroup
<a name="API_CreateReplicationGroup"></a>

Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. 

The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see [Creating a Subnet Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.Creating.html). For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see [Amazon Service Limits](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) and choose the limit type **Nodes per cluster per instance type**. 

When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use scaling. For more information, see [Scaling self-designed clusters](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Scaling.html) in the *ElastiCache User Guide*.

**Note**  
This operation is valid for Valkey and Redis OSS only.

## Request Parameters
<a name="API_CreateReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ReplicationGroupDescription **   
A user-created description for the replication group.  
Type: String  
Required: Yes

 ** ReplicationGroupId **   
The replication group identifier. This parameter is stored as a lowercase string.  
Constraints:  
+ A name must contain from 1 to 40 alphanumeric characters or hyphens.
+ The first character must be a letter.
+ A name cannot end with a hyphen or contain two consecutive hyphens.
Type: String  
Required: Yes

 ** AtRestEncryptionEnabled **   
A flag that enables encryption at rest when set to `true`.  
You cannot modify the value of `AtRestEncryptionEnabled` after the replication group is created. To enable encryption at rest on a replication group you must set `AtRestEncryptionEnabled` to `true` when you create the replication group.   
 **Required:** Only available when creating a replication group in an Amazon VPC using Valkey `7.2` and later, Redis OSS version `3.2.6`, or Redis OSS `4.x` and later.  
Default: `true` when using Valkey, `false` when using Redis OSS  
Type: Boolean  
Required: No

 ** AuthToken **   
 **Reserved parameter.** The password used to access a password protected server.  
 `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`.  
For HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`.
Password constraints:  
+ Must be only printable ASCII characters.
+ Must be at least 16 characters and no more than 128 characters in length.
+ The only permitted printable special characters are \$1, &, \$1, \$1, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.  
Type: String  
Required: No

 ** AutomaticFailoverEnabled **   
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.  
 `AutomaticFailoverEnabled` must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.  
Default: false  
Type: Boolean  
Required: No

 ** AutoMinorVersionUpgrade **   
 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.    
Type: Boolean  
Required: No

 ** CacheNodeType **   
The compute and memory capacity of the nodes in the node group (shard).  
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.  
+ General purpose:
  + Current generation: 

     **M7g node types**: `cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge` 

     **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge` 

     **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` 

     **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` 

     **T3 node types:** `cache.t3.micro`, `cache.t3.small`, `cache.t3.medium` 

     **T2 node types:** `cache.t2.micro`, `cache.t2.small`, `cache.t2.medium` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **T1 node types:** `cache.t1.micro` 

     **M1 node types:** `cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge` 

     **M3 node types:** `cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge` 
+ Compute optimized:
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **C1 node types:** `cache.c1.xlarge` 
+ Memory optimized:
  + Current generation: 

     **R7g node types**: `cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge` 

     **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge` 

     **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge` 

     **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` 
 **Additional node type info**   
+ All current generation instance types are created in Amazon VPC by default.
+ Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
+ Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
+ The configuration variables `appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
Type: String  
Required: No

 ** CacheParameterGroupName **   
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.  
If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.   
+ To create a Valkey or Redis OSS (cluster mode disabled) replication group, use `CacheParameterGroupName=default.redis3.2`.
+ To create a Valkey or Redis OSS (cluster mode enabled) replication group, use `CacheParameterGroupName=default.redis3.2.cluster.on`.
Type: String  
Required: No

 **CacheSecurityGroupNames.CacheSecurityGroupName.N**   
A list of cache security group names to associate with this replication group.  
Type: Array of strings  
Required: No

 ** CacheSubnetGroupName **   
The name of the cache subnet group to be used for the replication group.  
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [Subnets and Subnet Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.html).
Type: String  
Required: No

 ** ClusterMode **   
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.  
Type: String  
Valid Values: `enabled | disabled | compatible`   
Required: No

 ** DataTieringEnabled **   
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see [Data tiering](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/data-tiering.html).  
Type: Boolean  
Required: No

 ** Engine **   
The name of the cache engine to be used for the clusters in this replication group. The value must be set to `valkey` or `redis`.  
Type: String  
Required: No

 ** EngineVersion **   
The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the `DescribeCacheEngineVersions` operation.  
 **Important:** You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement)) in the *ElastiCache User Guide*, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.   
Type: String  
Required: No

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: No

 ** IpDiscovery **   
The network type you choose when creating a replication group, either `ipv4` \$1 `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](http://aws.amazon.com/ec2/nitro/).  
Type: String  
Valid Values: `ipv4 | ipv6`   
Required: No

 ** KmsKeyId **   
The ID of the KMS key used to encrypt the disk in the cluster.  
Type: String  
Required: No

 **LogDeliveryConfigurations.LogDeliveryConfigurationRequest.N**   
Specifies the destination, format and type of the logs.  
Type: Array of [LogDeliveryConfigurationRequest](API_LogDeliveryConfigurationRequest.md) objects  
Required: No

 ** MultiAZEnabled **   
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see [Minimizing Downtime: Multi-AZ](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/AutoFailover.html).  
Type: Boolean  
Required: No

 ** NetworkType **   
Must be either `ipv4` \$1 `ipv6` \$1 `dual_stack`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/).  
Type: String  
Valid Values: `ipv4 | ipv6 | dual_stack`   
Required: No

 **NodeGroupConfiguration.NodeGroupConfiguration.N**   
A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: `PrimaryAvailabilityZone`, `ReplicaAvailabilityZones`, `ReplicaCount`, and `Slots`.  
If you're creating a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Valkey or Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.  
Type: Array of [NodeGroupConfiguration](API_NodeGroupConfiguration.md) objects  
Required: No

 ** NotificationTopicArn **   
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.  
The Amazon SNS topic owner must be the same as the cluster owner.
Type: String  
Required: No

 ** NumCacheClusters **   
The number of clusters this replication group initially has.  
This parameter is not used if there is more than one node group (shard). You should use `ReplicasPerNodeGroup` instead.  
If `AutomaticFailoverEnabled` is `true`, the value of this parameter must be at least 2. If `AutomaticFailoverEnabled` is `false` you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.  
The maximum permitted value for `NumCacheClusters` is 6 (1 primary plus 5 replicas).  
Type: Integer  
Required: No

 ** NumNodeGroups **   
An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.  
Default: 1  
Type: Integer  
Required: No

 ** Port **   
The port number on which each member of the replication group accepts connections.  
Type: Integer  
Required: No

 **PreferredCacheClusterAZs.AvailabilityZone.N**   
A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.  
This parameter is not used if there is more than one node group (shard). You should use `NodeGroupConfiguration` instead.  
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.  
The number of Availability Zones listed must equal the value of `NumCacheClusters`.
Default: system chosen Availability Zones.  
Type: Array of strings  
Required: No

 ** PreferredMaintenanceWindow **   
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.  
Valid values for `ddd` are:  
+  `sun` 
+  `mon` 
+  `tue` 
+  `wed` 
+  `thu` 
+  `fri` 
+  `sat` 
Example: `sun:23:00-mon:01:30`   
Type: String  
Required: No

 ** PrimaryClusterId **   
The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of `available`.  
This parameter is not required if `NumCacheClusters`, `NumNodeGroups`, or `ReplicasPerNodeGroup` is specified.  
Type: String  
Required: No

 ** ReplicasPerNodeGroup **   
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.  
Type: Integer  
Required: No

 **SecurityGroupIds.SecurityGroupId.N**   
One or more Amazon VPC security groups associated with this replication group.  
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).  
Type: Array of strings  
Required: No

 ** ServerlessCacheSnapshotName **   
The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.  
Type: String  
Required: No

 **SnapshotArns.SnapshotArn.N**   
A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter *NumNodeGroups* or the number of node groups configured by *NodeGroupConfiguration* regardless of the number of ARNs specified here.  
Example of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb`   
Type: Array of strings  
Required: No

 ** SnapshotName **   
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to `restoring` while the new replication group is being created.  
Type: String  
Required: No

 ** SnapshotRetentionLimit **   
The number of days for which ElastiCache retains automatic 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.  
Default: 0 (i.e., automatic backups are disabled for this cluster).  
Type: Integer  
Required: No

 ** SnapshotWindow **   
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.  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=`myKey`, Value=`myKeyValue`. You can include multiple tags as shown following: Key=`myKey`, Value=`myKeyValue` Key=`mySecondKey`, Value=`mySecondKeyValue`. Tags on replication groups will be replicated to all nodes.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TransitEncryptionEnabled **   
A flag that enables in-transit encryption when set to `true`.  
This parameter is valid only if the `Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6`, `4.x` or later, and the cluster is being created in an Amazon VPC.  
If you enable in-transit encryption, you must also specify a value for `CacheSubnetGroup`.  
 **Required:** Only available when creating a replication group in an Amazon VPC using Redis OSS version `3.2.6`, `4.x` or later.  
Default: `false`   
For HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`.
Type: Boolean  
Required: No

 ** TransitEncryptionMode **   
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.  
When setting `TransitEncryptionEnabled` to `true`, you can set your `TransitEncryptionMode` to `preferred` in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to `required` to allow encrypted connections only.  
Setting `TransitEncryptionMode` to `required` is a two-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`.  
This process will not trigger the replacement of the replication group.  
Type: String  
Valid Values: `preferred | required`   
Required: No

 **UserGroupIds.member.N**   
The user group to associate with the replication group.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: No

## Response Elements
<a name="API_CreateReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_CreateReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

 ** ClusterQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of clusters per customer.  
HTTP Status Code: 400

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InsufficientCacheClusterCapacity **   
The requested cache node type is not available in the specified Availability Zone. For more information, see [InsufficientCacheClusterCapacity](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) in the ElastiCache User Guide.  
HTTP Status Code: 400

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidUserGroupState **   
The user group is not in an active state.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The VPC network is in an invalid state.  
HTTP Status Code: 400

 ** NodeGroupsPerReplicationGroupQuotaExceeded **   
The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90  
HTTP Status Code: 400

 ** NodeQuotaForClusterExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.  
HTTP Status Code: 400

 ** NodeQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.  
HTTP Status Code: 400

 ** ReplicationGroupAlreadyExists **   
The specified replication group already exists.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

## Examples
<a name="API_CreateReplicationGroup_Examples"></a>

### CreateReplicationGroup - Valkey or Redis OSS (cluster mode disabled) Replication Group
<a name="API_CreateReplicationGroup_Example_1"></a>

The following example creates a Valkey or Redis OSS (cluster mode disabled) replication group with three nodes (`NumCacheClusters=3`), a primary and two read replicas. Because a single node group (shard) replication group technically could be either clustered or non-clustered, the parameter group `default.redis3.2` is specified, making this is a non-clustered replication group.

#### Sample Request
<a name="API_CreateReplicationGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=CreateReplicationGroup 
   &CacheParameterGroup=default.redis3.2
   &Engine=redis
   &EngineVersion=3.2.4
   &NumCacheClusters=3
   &ReplicationGroupDescription=My%20replication%20group
   &ReplicationGroupId=my-repgroup
   &PrimaryClusterId=my-redis-primary
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_CreateReplicationGroup_Example_1_Response"></a>

```
<CreateReplicationGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <CreateReplicationGroupResult> 
      <ReplicationGroup> 
         <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> 
         <MemberClusters> 
            <ClusterId>my-redis-primary</ClusterId> 
         </MemberClusters> 
         <ReplicationGroupId>my-repgroup</ReplicationGroupId> 
         <Status>creating</Status> 
         <PendingModifiedValues /> 
         <Description>My replication group</Description> 
      </ReplicationGroup> 
   </CreateReplicationGroupResult> 
   <ResponseMetadata> 
      <RequestId>f3b7b32d-b9d2-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</CreateReplicationGroupResponse>
```

### Redis OSS (cluster mode enabled) Replication Group - all shards same profile
<a name="API_CreateReplicationGroup_Example_2"></a>

The following example creates a Valkey or Redis OSS (cluster mode enabled) replication group with three node groups (shards) and four replica nodes in each node group (shard). Note the following parameters and their values.
+ EngineVersion=3.2.4
+ CacheParameterGroup=default.redis3.2.cluster.on
+ NumNodeGroups=3
+ ReplicasPerNodeGroup=4

#### Sample Request
<a name="API_CreateReplicationGroup_Example_2_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=CreateReplicationGroup 
   &CacheParameterGroup=default.redis3.2.cluster.on
   &Engine=redis
   &EngineVersion=3.2.4
   &ReplicationGroupDescription=My%20replication%20group
   &ReplicationGroupId=my-repgroup
   &NumNodeGroups=3
   &PrimaryClusterId=my-redis-primary
   &ReplicasPerNodeGroup=4
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

### Valkey or Redis OSS (cluster mode enabled) Replication Group - each shard configured separately
<a name="API_CreateReplicationGroup_Example_3"></a>

The following example creates a Valkey or Redis OSS (cluster mode enabled) replication group with two node groups (shards). The first shard has two replica nodes and slots 0-8192. The second shard has one replica and slots 8193-16383. Note the following parameters and their values.
+ EngineVersion
+ CacheParameterGroup
+ NodeGroupConfiguration.NodeGroupConfiguration.*n*.PrimaryAvailabilityZone
+ NodeGroupConfiguration.NodeGroupConfiguration.*n*.ReplicaAvailabilityZones.AvailabilityZone.*n* 
+ NodeGroupConfiguration.NodeGroupConfiguration.*n*.ReplicaCount
+ NodeGroupConfiguration.NodeGroupConfiguration.*n*.Slots

#### Sample Request
<a name="API_CreateReplicationGroup_Example_3_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=CreateReplicationGroup 
   &CacheParameterGroup=default.redis3.2.cluster.on
   &Engine=redis
   &EngineVersion=3.2.4
   &ReplicationGroupDescription=My%20replication%20group
   &ReplicationGroupId=my-repgroup
   &NodeGroupConfiguration.NodeGroupConfiguration.1.PrimaryAvailabilityZone=us-east-2a
   &NodeGroupConfiguration.NodeGroupConfiguration.1.ReplicaAvailabilityZones.AvailabilityZone.1=us-east-2b
   &NodeGroupConfiguration.NodeGroupConfiguration.1.ReplicaAvailabilityZones.AvailabilityZone.2=us-east-2c
   &NodeGroupConfiguration.NodeGroupConfiguration.1.ReplicaCount=2
   &NodeGroupConfiguration.NodeGroupConfiguration.1.Slots=0-8192
   &NodeGroupConfiguration.NodeGroupConfiguration.2.PrimaryAvailabilityZone=us-east-2b
   &NodeGroupConfiguration.NodeGroupConfiguration.2.ReplicaAvailabilityZones.AvailabilityZone.1=us-east-2d
   &NodeGroupConfiguration.NodeGroupConfiguration.2.ReplicaCount=1
   &NodeGroupConfiguration.NodeGroupConfiguration.2.Slots=8193-16383
   &PrimaryClusterId=my-redis-primary
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_CreateReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateReplicationGroup) 

# CreateServerlessCache
<a name="API_CreateServerlessCache"></a>

Creates a serverless cache.

## Request Parameters
<a name="API_CreateServerlessCache_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
The name of the cache engine to be used for creating the serverless cache.  
Type: String  
Required: Yes

 ** ServerlessCacheName **   
User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

 ** CacheUsageLimits **   
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.  
Type: [CacheUsageLimits](API_CacheUsageLimits.md) object  
Required: No

 ** DailySnapshotTime **   
The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: No

 ** Description **   
User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.   
Type: String  
Required: No

 ** KmsKeyId **   
ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.  
Type: String  
Required: No

 ** MajorEngineVersion **   
The version of the cache engine that will be used to create the serverless cache.  
Type: String  
Required: No

 ** NetworkType **   
The IP protocol version used by the serverless cache. Must be either `ipv4` \$1 `ipv6` \$1 `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`.   
Type: String  
Valid Values: `ipv4 | ipv6 | dual_stack`   
Required: No

 **SecurityGroupIds.SecurityGroupId.N**   
A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.  
Type: Array of strings  
Required: No

 **SnapshotArnsToRestore.SnapshotArn.N**   
The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: Array of strings  
Required: No

 ** SnapshotRetentionLimit **   
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.  
Type: Integer  
Required: No

 **SubnetIds.SubnetId.N**   
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.  
Type: Array of strings  
Required: No

 **Tags.Tag.N**   
The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** UserGroupId **   
The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.  
Type: String  
Required: No

## Response Elements
<a name="API_CreateServerlessCache_ResponseElements"></a>

The following element is returned by the service.

 ** ServerlessCache **   
The response for the attempt to create the serverless cache.  
Type: [ServerlessCache](API_ServerlessCache.md) object

## Errors
<a name="API_CreateServerlessCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidCredentials **   
You must enter valid credentials.  
HTTP Status Code: 408

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidServerlessCacheStateFault **   
The account for these credentials is not currently active.  
HTTP Status Code: 400

 ** InvalidUserGroupState **   
The user group is not in an active state.  
HTTP Status Code: 400

 ** ServerlessCacheAlreadyExistsFault **   
A serverless cache with this name already exists.  
HTTP Status Code: 400

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServerlessCacheQuotaForCustomerExceededFault **   
The number of serverless caches exceeds the customer quota.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

## Examples
<a name="API_CreateServerlessCache_Examples"></a>

### CreateServerlessCache with Redis OSS
<a name="API_CreateServerlessCache_Example_1"></a>

This example illustrates one usage of CreateServerlessCache.

#### Sample Request
<a name="API_CreateServerlessCache_Example_1_Request"></a>

```
{
    "input": {
        "ServerlessCacheName": "my-serverless-cache",
        "Description": "A serverless cache.",
        "Engine": "redis",
        "MajorEngineVersion": "7",
        "SubnetIds": [
            "subnet-xxx8c982",
            "subnet-xxx382f3",
            "subnet-xxxb3e7c0"
        ],
        "CacheUsageLimits": {
            "DataStorage" : {
                "Maximum" : 10, 
                "Unit" : "GB"
            }, 
            "ECPUPerSecond" : {
                "Maximum" : 50000
            }
        },
        "SecurityGroupIds": [
            "sg-xxx0c9af"
        ],
        "SnapshotRetentionLimit": 10,
        "DailySnapshotTime": "09:00",
        "NetworkType": "ipv4"
    },
    "output": {
        "ServerlessCache": {
            "ServerlessCacheName": "my-serverless-cache",
            "Description": "A serverless cache.",
            "Status": "creating",
            "Engine": "redis",
            "MajorEngineVersion": "7",
            "FullEngineVersion": "7.0",
            "SubnetIds": [
                "subnet-xxx8c982",
                "subnet-xxx382f3",
                "subnet-xxxb3e7c0"
            ],
            "CacheUsageLimits": {
                "DataStorage" : {
                    "Maximum" : 10, 
                    "Unit" : "GB"
                }, 
                "ECPUPerSecond" : {
                    "Maximum" : 50000
                }
            },
            "SecurityGroupIds": [
                "sg-xxx0c9af"
            ],
            "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
            "SnapshotRetentionLimit": 10,
            "DailySnapshotTime": "09:00",
            "NetworkType": "ipv4"
        }
    }
}
```

### CreateServerlessCache (Memcached)
<a name="API_CreateServerlessCache_Example_2"></a>

This example illustrates one usage of CreateServerlessCache.

#### Sample Request
<a name="API_CreateServerlessCache_Example_2_Request"></a>

```
{
    "input": {
        "ServerlessCacheName": "my-serverless-cache",
        "Description": "A serverless cache.",
        "Engine": "memcached",
        "MajorEngineVersion": "1.6",
        "SubnetIds": [
            "subnet-xxx8c982",
            "subnet-xxx382f3",
            "subnet-xxxb3e7c0"
        ],
        "CacheUsageLimits": {
            "DataStorage" : {
                "Maximum" : 10, 
                "Unit" : "GB"
            }, 
            "ECPUPerSecond" : {
                "Maximum" : 50000
            }
        },
        "SecurityGroupIds": [
            "sg-xxx0c9af"
        ],
        "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
        "SnapshotRetentionLimit": 10,
        "DailySnapshotTime": "09:00",
        "NetworkType": "ipv4"
    },
    "output": {
        "ServerlessCache": {
            "ServerlessCacheName": "my-serverless-cache",
            "Description": "A serverless cache.",
            "Status": "creating",
            "Engine": "memcached",
            "MajorEngineVersion": "1.6",
            "FullEngineVersion": "1.6.21",
            "SubnetIds": [
                "subnet-xxx8c982",
                "subnet-xxx382f3",
                "subnet-xxxb3e7c0"
            ],
            "CacheUsageLimits": {
                "DataStorage" : {
                    "Maximum" : 10, 
                    "Unit" : "GB"
                }, 
                "ECPUPerSecond" : {
                    "Maximum" : 50000
                }
            },
            "SecurityGroupIds": [
                "sg-xxx0c9af"
            ],
            "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
            "SnapshotRetentionLimit": 10,
            "DailySnapshotTime": "09:00",
            "NetworkType": "ipv4"
        }
    }
}
```

## See Also
<a name="API_CreateServerlessCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateServerlessCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateServerlessCache) 

# CreateServerlessCacheSnapshot
<a name="API_CreateServerlessCacheSnapshot"></a>

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.

## Request Parameters
<a name="API_CreateServerlessCacheSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ServerlessCacheName **   
The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: Yes

 ** ServerlessCacheSnapshotName **   
The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 ** KmsKeyId **   
The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateServerlessCacheSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** ServerlessCacheSnapshot **   
The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: [ServerlessCacheSnapshot](API_ServerlessCacheSnapshot.md) object

## Errors
<a name="API_CreateServerlessCacheSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidServerlessCacheStateFault **   
The account for these credentials is not currently active.  
HTTP Status Code: 400

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServerlessCacheSnapshotAlreadyExistsFault **   
A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServerlessCacheSnapshotQuotaExceededFault **   
The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CreateServerlessCacheSnapshot_Examples"></a>

### CreateServerlessCacheSnapshot
<a name="API_CreateServerlessCacheSnapshot_Example_1"></a>

This example illustrates one usage of CreateServerlessCacheSnapshot.

#### Sample Request
<a name="API_CreateServerlessCacheSnapshot_Example_1_Request"></a>

```
{
    "input": {
        "ServerlessCacheSnapshotName": "my-serverless-cache-snapshot",
        "ServerlessCacheName": "my-serverless-cache"
    },
    "output": {
        "ServerlessCacheSnapshot": {
            "ServerlessCacheSnapshotName": "my-serverless-cache-snapshot",
            "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscachesnapshot:my-serverless-cache-snapshot",
            "SnapshotType": "manual",
            "Status": "creating",
            "ServerlessCacheConfiguration": {
                "ServerlessCacheName": "my-serverless-cache",
                "Engine": "redis",
                "MajorEngineVersion": "7"
            }
        }    
    }
}
```

## See Also
<a name="API_CreateServerlessCacheSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateServerlessCacheSnapshot) 

# CreateSnapshot
<a name="API_CreateSnapshot"></a>

Creates a copy of an entire cluster or replication group at a specific moment in time.

**Note**  
This operation is valid for Valkey or Redis OSS only.

## Request Parameters
<a name="API_CreateSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SnapshotName **   
A name for the snapshot being created. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 ** CacheClusterId **   
The identifier of an existing cluster. The snapshot is created from this cluster.  
Type: String  
Required: No

 ** KmsKeyId **   
The ID of the KMS key used to encrypt the snapshot.  
Type: String  
Required: No

 ** ReplicationGroupId **   
The identifier of an existing replication group. The snapshot is created from this replication group.  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** Snapshot **   
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_CreateSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** SnapshotAlreadyExistsFault **   
You already have a snapshot with the given name.  
HTTP Status Code: 400

 ** SnapshotFeatureNotSupportedFault **   
You attempted one of the following operations:  
+ Creating a snapshot of a Valkey or Redis OSS cluster running on a `cache.t1.micro` cache node.
+ Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.
Neither of these are supported by ElastiCache.  
HTTP Status Code: 400

 ** SnapshotQuotaExceededFault **   
The request cannot be processed because it would exceed the maximum number of snapshots.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_CreateSnapshot_Examples"></a>

### CreateSnapshot
<a name="API_CreateSnapshot_Example_1"></a>

This example illustrates one usage of CreateSnapshot.

#### Sample Request
<a name="API_CreateSnapshot_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=CreateSnapshot
   &CacheClusterId=my-redis-primary
   &SnapshotName=my-manual-snapshot
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_CreateSnapshot_Example_1_Response"></a>

```
<CreateSnapshotResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <CreateSnapshotResult> 
      <Snapshot> 
         <CacheClusterId>my-redis-primary</CacheClusterId> 
         <Port>6379</Port> 
         <CacheNodeType>cache.m1.small</CacheNodeType> 
         <CacheParameterGroupName>default.redis2.8</CacheParameterGroupName> 
         <Engine>redis</Engine> 
         <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone> 
         <CacheClusterCreateTime>2015-02-02T18:46:57.972Z</CacheClusterCreateTime> 
         <EngineVersion>2.8.6</EngineVersion> 
         <SnapshotSource>manual</SnapshotSource> 
         <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
         <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> 
         <SnapshotName>my-manual-snapshot</SnapshotName> 
         <SnapshotRetentionLimit>5</SnapshotRetentionLimit> 
         <NodeSnapshots> 
            <NodeSnapshot> 
               <CacheNodeCreateTime>2015-02-02T18:46:57.972Z</CacheNodeCreateTime> 
               <CacheNodeId>0001</CacheNodeId> 
               <CacheSize /> 
            </NodeSnapshot> 
         </NodeSnapshots> 
         <SnapshotStatus>creating</SnapshotStatus> 
         <NumCacheNodes>1</NumCacheNodes> 
         <SnapshotWindow>07:30-08:30</SnapshotWindow> 
      </Snapshot> 
   </CreateSnapshotResult> 
   <ResponseMetadata> 
      <RequestId>faf5a232-b9ce-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</CreateSnapshotResponse>
```

## See Also
<a name="API_CreateSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateSnapshot) 

# CreateUser
<a name="API_CreateUser"></a>

For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see [Using Role Based Access Control (RBAC)](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html).

## Request Parameters
<a name="API_CreateUser_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** AccessString **   
Access permissions string used for this user.  
Type: String  
Pattern: `.*\S.*`   
Required: Yes

 ** Engine **   
The options are valkey or redis.   
Type: String  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** UserId **   
The ID of the user. This value is stored as a lowercase string.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: Yes

 ** UserName **   
The username of the user.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** AuthenticationMode **   
Specifies how to authenticate the user.  
Type: [AuthenticationMode](API_AuthenticationMode.md) object  
Required: No

 ** NoPasswordRequired **   
Indicates a password is not required for this user.  
Type: Boolean  
Required: No

 **Passwords.member.N**   
Passwords used for this user. You can create up to two passwords for each user.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_CreateUser_ResponseElements"></a>

The following elements are returned by the service.

 ** AccessString **   
Access permissions string used for this user.  
Type: String

 ** ARN **   
The Amazon Resource Name (ARN) of the user.  
Type: String

 ** Authentication **   
Denotes whether the user requires a password to authenticate.  
Type: [Authentication](API_Authentication.md) object

 ** Engine **   
The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*` 

 ** MinimumEngineVersion **   
The minimum engine version required, which is Redis OSS 6.0  
Type: String

 ** Status **   
Indicates the user status. Can be "active", "modifying" or "deleting".  
Type: String

 **UserGroupIds.member.N**   
Returns a list of the user group IDs the user belongs to.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` 

 ** UserId **   
The ID of the user.  
Type: String

 ** UserName **   
The username of the user.  
Type: String

## Errors
<a name="API_CreateUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DuplicateUserName **   
A user with this username already exists.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

 ** UserAlreadyExists **   
A user with this ID already exists.  
HTTP Status Code: 400

 ** UserQuotaExceeded **   
The quota of users has been exceeded.  
HTTP Status Code: 400

## See Also
<a name="API_CreateUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateUser) 

# CreateUserGroup
<a name="API_CreateUserGroup"></a>

For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more information, see [Using Role Based Access Control (RBAC)](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html) 

## Request Parameters
<a name="API_CreateUserGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
Sets the engine listed in a user group. The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*`   
Required: Yes

 ** UserGroupId **   
The ID of the user group. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Valkey and Redis OSS only.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 **UserIds.member.N**   
The list of user IDs that belong to the user group.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: No

## Response Elements
<a name="API_CreateUserGroup_ResponseElements"></a>

The following elements are returned by the service.

 ** ARN **   
The Amazon Resource Name (ARN) of the user group.  
Type: String

 ** Engine **   
The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*` 

 ** MinimumEngineVersion **   
The minimum engine version required, which is Redis OSS 6.0  
Type: String

 ** PendingChanges **   
A list of updates being applied to the user group.  
Type: [UserGroupPendingChanges](API_UserGroupPendingChanges.md) object

 **ReplicationGroups.member.N**   
A list of replication groups that the user group can access.  
Type: Array of strings

 **ServerlessCaches.member.N**   
Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: Array of strings

 ** Status **   
Indicates user group status. Can be "creating", "active", "modifying", "deleting".  
Type: String

 ** UserGroupId **   
The ID of the user group.  
Type: String

 **UserIds.member.N**   
The list of user IDs that belong to the user group.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` 

## Errors
<a name="API_CreateUserGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DefaultUserRequired **   
You must add default user to a user group.  
HTTP Status Code: 400

 ** DuplicateUserName **   
A user with this username already exists.  
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

 ** UserGroupAlreadyExists **   
The user group with this ID already exists.  
HTTP Status Code: 400

 ** UserGroupQuotaExceeded **   
The number of users exceeds the user group limit.  
HTTP Status Code: 400

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## See Also
<a name="API_CreateUserGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/CreateUserGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/CreateUserGroup) 

# DecreaseNodeGroupsInGlobalReplicationGroup
<a name="API_DecreaseNodeGroupsInGlobalReplicationGroup"></a>

Decreases the number of node groups in a Global datastore

## Request Parameters
<a name="API_DecreaseNodeGroupsInGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyImmediately **   
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.   
Type: Boolean  
Required: Yes

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: Yes

 ** NodeGroupCount **   
The number of node groups (shards) that results from the modification of the shard configuration  
Type: Integer  
Required: Yes

 **GlobalNodeGroupsToRemove.GlobalNodeGroupId.N**   
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.   
Type: Array of strings  
Required: No

 **GlobalNodeGroupsToRetain.GlobalNodeGroupId.N**   
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.   
Type: Array of strings  
Required: No

## Response Elements
<a name="API_DecreaseNodeGroupsInGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_DecreaseNodeGroupsInGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_DecreaseNodeGroupsInGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DecreaseNodeGroupsInGlobalReplicationGroup) 

# DecreaseReplicaCount
<a name="API_DecreaseReplicaCount"></a>

Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

## Request Parameters
<a name="API_DecreaseReplicaCount_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyImmediately **   
If `True`, the number of replica nodes is decreased immediately. `ApplyImmediately=False` is not currently supported.  
Type: Boolean  
Required: Yes

 ** ReplicationGroupId **   
The id of the replication group from which you want to remove replica nodes.  
Type: String  
Required: Yes

 ** NewReplicaCount **   
The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.  
The minimum number of replicas in a shard or replication group is:  
+ Valkey or Redis OSS (cluster mode disabled)
  + If Multi-AZ is enabled: 1
  + If Multi-AZ is not enabled: 0
+ Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
Type: Integer  
Required: No

 **ReplicaConfiguration.ConfigureShard.N**   
A list of `ConfigureShard` objects that can be used to configure each shard in a Valkey or Redis OSS replication group. The `ConfigureShard` has three members: `NewReplicaCount`, `NodeGroupId`, and `PreferredAvailabilityZones`.  
Type: Array of [ConfigureShard](API_ConfigureShard.md) objects  
Required: No

 **ReplicasToRemove.member.N**   
A list of the node ids to remove from the replication group or node group (shard).  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_DecreaseReplicaCount_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_DecreaseReplicaCount_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClusterQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of clusters per customer.  
HTTP Status Code: 400

 ** InsufficientCacheClusterCapacity **   
The requested cache node type is not available in the specified Availability Zone. For more information, see [InsufficientCacheClusterCapacity](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) in the ElastiCache User Guide.  
HTTP Status Code: 400

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The VPC network is in an invalid state.  
HTTP Status Code: 400

 ** NodeGroupsPerReplicationGroupQuotaExceeded **   
The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90  
HTTP Status Code: 400

 ** NodeQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.  
HTTP Status Code: 400

 ** NoOperationFault **   
The operation was not performed because no changes were required.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

## Examples
<a name="API_DecreaseReplicaCount_Examples"></a>

### Example
<a name="API_DecreaseReplicaCount_Example_1"></a>

The following example removes two replicas from each node group in the replication group `sample-repl-group`.

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DecreaseReplicaCount
   &ApplyImmediately=True
   &NewReplicaCount=2
   &ReplicasToRemove.ReplicaToRemove.1=0001
   &ReplicasToRemove.ReplicaToRemove.2=0003
   &ReplicationGroupId=sample-repl-group
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

### Example
<a name="API_DecreaseReplicaCount_Example_2"></a>

The following example removes replicas from two node groups. Because there are multiple node groups, this example is for a Valkey or Redis OSS (cluster mode enabled) replication group.

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DecreaseReplicaCount
   &ApplyImmediately=True
   &ReplicaConfiguration.ConfigureShard.1.NodeGroupId=0001
   &ReplicaConfiguration.ConfigureShard.1.NewReplicaCount=1
   &ReplicaConfiguration.ConfigureShard.1.PreferredAvailabilityZones.PreferredAvailabilityZone.1=us-east-1a
   &ReplicaConfiguration.ConfigureShard.1.PreferredAvailabilityZones.PreferredAvailabilityZone.2=us-east-1c
   &ReplicaConfiguration.ConfigureShard.2.NodeGroupId=0003
   &ReplicaConfiguration.ConfigureShard.2.NewReplicaCount=2
   &ReplicaConfiguration.ConfigureShard.2.PreferredAvailabilityZones.PreferredAvailabilityZone.1=us-east-1a
   &ReplicaConfiguration.ConfigureShard.2.PreferredAvailabilityZones.PreferredAvailabilityZone.2=us-east-1b
   &ReplicaConfiguration.ConfigureShard.2.PreferredAvailabilityZones.PreferredAvailabilityZone.4=us-east-1c
   &ReplicationGroupId=samplem--repl-group
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_DecreaseReplicaCount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DecreaseReplicaCount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DecreaseReplicaCount) 

# DeleteCacheCluster
<a name="API_DeleteCacheCluster"></a>

Deletes a previously provisioned cluster. `DeleteCacheCluster` deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:
+ Valkey or Redis OSS (cluster mode enabled) clusters
+ Valkey or Redis OSS (cluster mode disabled) clusters
+ A cluster that is the last read replica of a replication group
+ A cluster that is the primary node of a replication group
+ A node group (shard) that has Multi-AZ mode enabled
+ A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group
+ A cluster that is not in the `available` state

## Request Parameters
<a name="API_DeleteCacheCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheClusterId **   
The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.  
Type: String  
Required: Yes

 ** FinalSnapshotIdentifier **   
The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.  
Type: String  
Required: No

## Response Elements
<a name="API_DeleteCacheCluster_ResponseElements"></a>

The following element is returned by the service.

 ** CacheCluster **   
Contains all of the attributes of a specific cluster.  
Type: [CacheCluster](API_CacheCluster.md) object

## Errors
<a name="API_DeleteCacheCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** SnapshotAlreadyExistsFault **   
You already have a snapshot with the given name.  
HTTP Status Code: 400

 ** SnapshotFeatureNotSupportedFault **   
You attempted one of the following operations:  
+ Creating a snapshot of a Valkey or Redis OSS cluster running on a `cache.t1.micro` cache node.
+ Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.
Neither of these are supported by ElastiCache.  
HTTP Status Code: 400

 ** SnapshotQuotaExceededFault **   
The request cannot be processed because it would exceed the maximum number of snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteCacheCluster_Examples"></a>

### DeleteCacheCluster
<a name="API_DeleteCacheCluster_Example_1"></a>

This example illustrates one usage of DeleteCacheCluster.

#### Sample Request
<a name="API_DeleteCacheCluster_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DeleteCacheCluster
   &CacheClusterId=simcoprod43
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DeleteCacheCluster_Example_1_Response"></a>

```
<DeleteCacheClusterResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
   <DeleteCacheClusterResult>
      <CacheCluster>
         <CacheParameterGroup>
            <ParameterApplyStatus>in-sync</ParameterApplyStatus>
            <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>
            <CacheNodeIdsToReboot/>
         </CacheParameterGroup>
         <CacheClusterId>simcoprod43</CacheClusterId>
         <CacheClusterStatus>deleting</CacheClusterStatus>
         <ConfigurationEndpoint>
            <Port>11211</Port>
            <Address>simcoprod43.m2st2p.cfg.cache.amazonaws.com</Address>
         </ConfigurationEndpoint>
         <CacheNodeType>cache.m1.large</CacheNodeType>
         <Engine>memcached</Engine>
         <PendingModifiedValues/>
         <PreferredAvailabilityZone>us-west-2b</PreferredAvailabilityZone>
         <CacheClusterCreateTime>2015-02-02T02:18:26.497Z</CacheClusterCreateTime>
         <EngineVersion>1.4.5</EngineVersion>
         <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
         <PreferredMaintenanceWindow>mon:05:00-mon:06:00</PreferredMaintenanceWindow>
         <CacheSecurityGroups>
            <CacheSecurityGroup>
               <CacheSecurityGroupName>default</CacheSecurityGroupName>
               <Status>active</Status>
            </CacheSecurityGroup>
         </CacheSecurityGroups>
         <NumCacheNodes>3</NumCacheNodes>
      </CacheCluster>
   </DeleteCacheClusterResult>
   <ResponseMetadata>
      <RequestId>ab84aa7e-b7fa-11e0-9b0b-a9261be2b354</RequestId>
   </ResponseMetadata>
</DeleteCacheClusterResponse>
```

## See Also
<a name="API_DeleteCacheCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteCacheCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteCacheCluster) 

# DeleteCacheParameterGroup
<a name="API_DeleteCacheParameterGroup"></a>

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.

## Request Parameters
<a name="API_DeleteCacheParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupName **   
The name of the cache parameter group to delete.  
The specified cache security group must not be associated with any clusters.
Type: String  
Required: Yes

## Errors
<a name="API_DeleteCacheParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** InvalidCacheParameterGroupState **   
The current state of the cache parameter group does not allow the requested operation to occur.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DeleteCacheParameterGroup_Examples"></a>

### DeleteCacheParameterGroup
<a name="API_DeleteCacheParameterGroup_Example_1"></a>

This example illustrates one usage of DeleteCacheParameterGroup.

#### Sample Request
<a name="API_DeleteCacheParameterGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DeleteCacheParameterGroup
   &CacheParameterGroupName=myparametergroup
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DeleteCacheParameterGroup_Example_1_Response"></a>

```
<DeleteCacheParameterGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <ResponseMetadata>
    <RequestId>d0a417cb-575b-11e0-8869-cd22b4f9d96f</RequestId>
  </ResponseMetadata>
</DeleteCacheParameterGroupResponse>
```

## See Also
<a name="API_DeleteCacheParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteCacheParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteCacheParameterGroup) 

# DeleteCacheSecurityGroup
<a name="API_DeleteCacheSecurityGroup"></a>

Deletes a cache security group.

**Note**  
You cannot delete a cache security group if it is associated with any clusters.

## Request Parameters
<a name="API_DeleteCacheSecurityGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSecurityGroupName **   
The name of the cache security group to delete.  
You cannot delete the default security group.
Type: String  
Required: Yes

## Errors
<a name="API_DeleteCacheSecurityGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** InvalidCacheSecurityGroupState **   
The current state of the cache security group does not allow deletion.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DeleteCacheSecurityGroup_Examples"></a>

### DeleteCacheSecurityGroup
<a name="API_DeleteCacheSecurityGroup_Example_1"></a>

This example illustrates one usage of DeleteCacheSecurityGroup.

#### Sample Request
<a name="API_DeleteCacheSecurityGroup_Example_1_Request"></a>

```
   https://elasticache.us-west-2.amazonaws.com/
   ?Action=DeleteCacheSecurityGroup
   &CacheSecurityGroupName=mycachesecuritygroup3
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DeleteCacheSecurityGroup_Example_1_Response"></a>

```
<DeleteCacheSecurityGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
    <ResponseMetadata>
        <RequestId>c130cfb7-3650-11e0-ae57-f96cfe56749c</RequestId>
    </ResponseMetadata>
</DeleteCacheSecurityGroupResponse>
```

## See Also
<a name="API_DeleteCacheSecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteCacheSecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteCacheSecurityGroup) 

# DeleteCacheSubnetGroup
<a name="API_DeleteCacheSubnetGroup"></a>

Deletes a cache subnet group.

**Note**  
You cannot delete a default cache subnet group or one that is associated with any clusters.

## Request Parameters
<a name="API_DeleteCacheSubnetGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSubnetGroupName **   
The name of the cache subnet group to delete.  
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.  
Type: String  
Required: Yes

## Errors
<a name="API_DeleteCacheSubnetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheSubnetGroupInUse **   
The requested cache subnet group is currently in use.  
HTTP Status Code: 400

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteCacheSubnetGroup_Examples"></a>

### DeleteCacheSubnetGroup
<a name="API_DeleteCacheSubnetGroup_Example_1"></a>

This example illustrates one usage of DeleteCacheSubnetGroup.

#### Sample Request
<a name="API_DeleteCacheSubnetGroup_Example_1_Request"></a>

```
https://elasticache.amazonaws.com/
   ?Action=DeleteCacheSubnetGroup
   &CacheSubnetGroupName=mysubnetgroup
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DeleteCacheSubnetGroup_Example_1_Response"></a>

```
<DeleteCacheSubnetGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
      <ResponseMetadata>
        <RequestId>5d013245-4172-11df-8520-e7e1e602a915</RequestId>
      </ResponseMetadata>
    </DeleteCacheSubnetGroupResponse>
```

## See Also
<a name="API_DeleteCacheSubnetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteCacheSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteCacheSubnetGroup) 

# DeleteGlobalReplicationGroup
<a name="API_DeleteGlobalReplicationGroup"></a>

Deleting a Global datastore is a two-step process: 
+ First, you must [DisassociateGlobalReplicationGroup](API_DisassociateGlobalReplicationGroup.md) to remove the secondary clusters in the Global datastore.
+ Once the Global datastore contains only the primary cluster, you can use the `DeleteGlobalReplicationGroup` API to delete the Global datastore while retainining the primary cluster using `RetainPrimaryReplicationGroup=true`.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting `RetainPrimaryReplicationGroup=true`. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

## Request Parameters
<a name="API_DeleteGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: Yes

 ** RetainPrimaryReplicationGroup **   
The primary replication group is retained as a standalone replication group.   
Type: Boolean  
Required: Yes

## Response Elements
<a name="API_DeleteGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_DeleteGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_DeleteGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteGlobalReplicationGroup) 

# DeleteReplicationGroup
<a name="API_DeleteReplicationGroup"></a>

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting `RetainPrimaryCluster=true`.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

**Note**  
 `CreateSnapshot` permission is required to create a final snapshot. Without this permission, the API call will fail with an `Access Denied` exception.
This operation is valid for Redis OSS only.

## Request Parameters
<a name="API_DeleteReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ReplicationGroupId **   
The identifier for the cluster to be deleted. This parameter is not case sensitive.  
Type: String  
Required: Yes

 ** FinalSnapshotIdentifier **   
The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.  
Type: String  
Required: No

 ** RetainPrimaryCluster **   
If set to `true`, all of the read replicas are deleted, but the primary node is retained.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DeleteReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_DeleteReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** SnapshotAlreadyExistsFault **   
You already have a snapshot with the given name.  
HTTP Status Code: 400

 ** SnapshotFeatureNotSupportedFault **   
You attempted one of the following operations:  
+ Creating a snapshot of a Valkey or Redis OSS cluster running on a `cache.t1.micro` cache node.
+ Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.
Neither of these are supported by ElastiCache.  
HTTP Status Code: 400

 ** SnapshotQuotaExceededFault **   
The request cannot be processed because it would exceed the maximum number of snapshots.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteReplicationGroup_Examples"></a>

### DeleteReplicationGroup
<a name="API_DeleteReplicationGroup_Example_1"></a>

This example illustrates one usage of DeleteReplicationGroup.

#### Sample Request
<a name="API_DeleteReplicationGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DeleteReplicationGroup &RetainPrimaryCluster=false
   &FinalSnapshotIdentifier=my-final-snapshot
   &ReplicationGroupId=my-repgroup
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DeleteReplicationGroup_Example_1_Response"></a>

```
<DeleteReplicationGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <DeleteReplicationGroupResult> 
      <ReplicationGroup> 
         <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> 
decrease-replica-count         <ReplicationGroupId>my-repgroup</ReplicationGroupId> 
         <Status>deleting</Status> 
         <PendingModifiedValues /> 
         <Description>My replication group</Description> 
      </ReplicationGroup> 
   </DeleteReplicationGroupResult> 
   <ResponseMetadata> 
      <RequestId>93eb37db-b9d7-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</DeleteReplicationGroupResponse>
```

## See Also
<a name="API_DeleteReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteReplicationGroup) 

# DeleteServerlessCache
<a name="API_DeleteServerlessCache"></a>

Deletes a specified existing serverless cache.

**Note**  
 `CreateServerlessCacheSnapshot` permission is required to create a final snapshot. Without this permission, the API call will fail with an `Access Denied` exception.

## Request Parameters
<a name="API_DeleteServerlessCache_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ServerlessCacheName **   
The identifier of the serverless cache to be deleted.  
Type: String  
Required: Yes

 ** FinalSnapshotName **   
Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL, i.e. a final snapshot is not taken.  
Type: String  
Required: No

## Response Elements
<a name="API_DeleteServerlessCache_ResponseElements"></a>

The following element is returned by the service.

 ** ServerlessCache **   
Provides the details of the specified serverless cache that is about to be deleted.  
Type: [ServerlessCache](API_ServerlessCache.md) object

## Errors
<a name="API_DeleteServerlessCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidCredentials **   
You must enter valid credentials.  
HTTP Status Code: 408

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidServerlessCacheStateFault **   
The account for these credentials is not currently active.  
HTTP Status Code: 400

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServerlessCacheSnapshotAlreadyExistsFault **   
A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteServerlessCache_Examples"></a>

### DeleteServerlessCache
<a name="API_DeleteServerlessCache_Example_1"></a>

This example illustrates one usage of DeleteServerlessCache.

#### Sample Request
<a name="API_DeleteServerlessCache_Example_1_Request"></a>

```
{
    "input": {
        "ServerlessCacheName": "my-serverless-cache"
    },
    "output": {
        "ServerlessCache": {
            "ServerlessCacheName": "my-serverless-cache",
            "Description": "A serverless cache.",
            "Status": "deleting",
            "Engine": "redis",
            "MajorEngineVersion": "7",
            "FullEngineVersion": "7.0",
            "SubnetIds": [
                "subnet-xxx8c982",
                "subnet-xxx382f3",
                "subnet-xxxb3e7c0"
            ],
            "SecurityGroupIds": [
                "sg-xxx0c9af"
            ],
            "Endpoint": {
                "Address": "my-serverless-cache-xxxxx.serverless.use1qa.cache.amazonaws.com",
                "Port": 6379
            },
            "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
            "SnapshotRetentionLimit": 10,
            "DailySnapshotTime": "11:00",
            "NetworkType": "ipv4"
        }
    }
}
```

## See Also
<a name="API_DeleteServerlessCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteServerlessCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteServerlessCache) 

# DeleteServerlessCacheSnapshot
<a name="API_DeleteServerlessCacheSnapshot"></a>

Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

## Request Parameters
<a name="API_DeleteServerlessCacheSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ServerlessCacheSnapshotName **   
Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteServerlessCacheSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** ServerlessCacheSnapshot **   
The snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: [ServerlessCacheSnapshot](API_ServerlessCacheSnapshot.md) object

## Errors
<a name="API_DeleteServerlessCacheSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidServerlessCacheSnapshotStateFault **   
The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServerlessCacheSnapshotNotFoundFault **   
This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 404

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteServerlessCacheSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteServerlessCacheSnapshot) 

# DeleteSnapshot
<a name="API_DeleteSnapshot"></a>

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

**Note**  
This operation is valid for Valkey or Redis OSS only.

## Request Parameters
<a name="API_DeleteSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** SnapshotName **   
The name of the snapshot to be deleted.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** Snapshot **   
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_DeleteSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidSnapshotState **   
The current state of the snapshot does not allow the requested operation to occur.  
HTTP Status Code: 400

 ** SnapshotNotFoundFault **   
The requested snapshot name does not refer to an existing snapshot.  
HTTP Status Code: 404

## Examples
<a name="API_DeleteSnapshot_Examples"></a>

### DeleteSnapshot
<a name="API_DeleteSnapshot_Example_1"></a>

This example illustrates one usage of DeleteSnapshot.

#### Sample Request
<a name="API_DeleteSnapshot_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DeleteSnapshot
   &SnapshotName=my-manual-snapshot
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DeleteSnapshot_Example_1_Response"></a>

```
<DeleteSnapshotResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <DeleteSnapshotResult> 
      <Snapshot> 
         <CacheClusterId>my-redis-primary</CacheClusterId> 
         <Port>6379</Port> 
         <CacheNodeType>cache.m1.small</CacheNodeType> 
         <CacheParameterGroupName>default.redis2.8</CacheParameterGroupName> 
         <Engine>redis</Engine> 
         <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone> 
         <CacheClusterCreateTime>2015-02-02T18:46:57.972Z</CacheClusterCreateTime> 
         <EngineVersion>2.8.6</EngineVersion> 
         <SnapshotSource>manual</SnapshotSource> 
         <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
         <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> 
         <SnapshotName>my-manual-snapshot</SnapshotName> 
         <SnapshotRetentionLimit>5</SnapshotRetentionLimit> 
         <NodeSnapshots> 
            <NodeSnapshot> 
               <SnapshotCreateTime>2015-02-02T18:54:12Z</SnapshotCreateTime> 
               <CacheNodeCreateTime>2015-02-02T18:46:57.972Z</CacheNodeCreateTime> 
               <CacheNodeId>0001</CacheNodeId> 
               <CacheSize>3 MB</CacheSize> 
            </NodeSnapshot> 
         </NodeSnapshots> 
         <SnapshotStatus>deleting</SnapshotStatus> 
         <NumCacheNodes>1</NumCacheNodes> 
         <SnapshotWindow>07:30-08:30</SnapshotWindow> 
      </Snapshot> 
   </DeleteSnapshotResult> 
   <ResponseMetadata> 
      <RequestId>694d7017-b9d2-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</DeleteSnapshotResponse>
```

## See Also
<a name="API_DeleteSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteSnapshot) 

# DeleteUser
<a name="API_DeleteUser"></a>

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see [Using Role Based Access Control (RBAC)](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html). 

## Request Parameters
<a name="API_DeleteUser_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** UserId **   
The ID of the user.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: Yes

## Response Elements
<a name="API_DeleteUser_ResponseElements"></a>

The following elements are returned by the service.

 ** AccessString **   
Access permissions string used for this user.  
Type: String

 ** ARN **   
The Amazon Resource Name (ARN) of the user.  
Type: String

 ** Authentication **   
Denotes whether the user requires a password to authenticate.  
Type: [Authentication](API_Authentication.md) object

 ** Engine **   
The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*` 

 ** MinimumEngineVersion **   
The minimum engine version required, which is Redis OSS 6.0  
Type: String

 ** Status **   
Indicates the user status. Can be "active", "modifying" or "deleting".  
Type: String

 **UserGroupIds.member.N**   
Returns a list of the user group IDs the user belongs to.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` 

 ** UserId **   
The ID of the user.  
Type: String

 ** UserName **   
The username of the user.  
Type: String

## Errors
<a name="API_DeleteUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DefaultUserAssociatedToUserGroup **   
The default user assigned to the user group.  
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidUserState **   
The user is not in active state.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## See Also
<a name="API_DeleteUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteUser) 

# DeleteUserGroup
<a name="API_DeleteUserGroup"></a>

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see [Using Role Based Access Control (RBAC)](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html). 

## Request Parameters
<a name="API_DeleteUserGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** UserGroupId **   
The ID of the user group.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteUserGroup_ResponseElements"></a>

The following elements are returned by the service.

 ** ARN **   
The Amazon Resource Name (ARN) of the user group.  
Type: String

 ** Engine **   
The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*` 

 ** MinimumEngineVersion **   
The minimum engine version required, which is Redis OSS 6.0  
Type: String

 ** PendingChanges **   
A list of updates being applied to the user group.  
Type: [UserGroupPendingChanges](API_UserGroupPendingChanges.md) object

 **ReplicationGroups.member.N**   
A list of replication groups that the user group can access.  
Type: Array of strings

 **ServerlessCaches.member.N**   
Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: Array of strings

 ** Status **   
Indicates user group status. Can be "creating", "active", "modifying", "deleting".  
Type: String

 ** UserGroupId **   
The ID of the user group.  
Type: String

 **UserIds.member.N**   
The list of user IDs that belong to the user group.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` 

## Errors
<a name="API_DeleteUserGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidUserGroupState **   
The user group is not in an active state.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

## See Also
<a name="API_DeleteUserGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DeleteUserGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DeleteUserGroup) 

# DescribeCacheClusters
<a name="API_DescribeCacheClusters"></a>

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

By default, abbreviated information about the clusters is returned. You can use the optional *ShowCacheNodeInfo* flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the *creating* state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the *deleting* state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is *available*, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

## Request Parameters
<a name="API_DescribeCacheClusters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheClusterId **   
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.  
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

 ** ShowCacheClustersNotInReplicationGroups **   
An optional flag that can be included in the `DescribeCacheCluster` request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.  
Type: Boolean  
Required: No

 ** ShowCacheNodeInfo **   
An optional flag that can be included in the `DescribeCacheCluster` request to retrieve information about the individual cache nodes.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DescribeCacheClusters_ResponseElements"></a>

The following elements are returned by the service.

 **CacheClusters.CacheCluster.N**   
A list of clusters. Each item in the list contains detailed information about one cluster.  
Type: Array of [CacheCluster](API_CacheCluster.md) objects

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

## Errors
<a name="API_DescribeCacheClusters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCacheClusters_Examples"></a>

### DescribeCacheClusters
<a name="API_DescribeCacheClusters_Example_1"></a>

This example illustrates one usage of DescribeCacheClusters.

#### Sample Request
<a name="API_DescribeCacheClusters_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeCacheClusters
   &MaxRecords=100
   &ShowCacheNodeInfo=false
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeCacheClusters_Example_1_Response"></a>

```
<DescribeCacheClustersResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeCacheClustersResult>
    <CacheClusters>
      <CacheCluster>
        <CacheParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>
          <CacheNodeIdsToReboot/>
        </CacheParameterGroup>
        <CacheClusterId>simcoprod42</CacheClusterId>
        <CacheClusterStatus>available</CacheClusterStatus>
        <ConfigurationEndpoint>
          <Port>11211</Port>
          <Address>simcoprod42.m2st2p.cfg.cache.amazonaws.com</Address>
        </ConfigurationEndpoint>
        <ClientDownloadLandingPage>
          https://console.aws.amazon.com/elasticache/home#client-download:
        </ClientDownloadLandingPage>
        <CacheNodeType>cache.m1.large</CacheNodeType>
        <Engine>memcached</Engine>
        <PendingModifiedValues/>
        <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone>
        <CacheClusterCreateTime>2015-02-02T01:21:46.607Z</CacheClusterCreateTime>
        <EngineVersion>1.4.5</EngineVersion>
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
        <PreferredMaintenanceWindow>fri:08:30-fri:09:30</PreferredMaintenanceWindow>
        <CacheSecurityGroups>
          <CacheSecurityGroup>
            <CacheSecurityGroupName>default</CacheSecurityGroupName>
            <Status>active</Status>
          </CacheSecurityGroup>
        </CacheSecurityGroups>
        <NotificationConfiguration>
          <TopicStatus>active</TopicStatus>
          <TopicArn>arn:aws:sns:us-west-2:123456789012:ElastiCacheNotifications</TopicArn>
        </NotificationConfiguration>
        <NumCacheNodes>6</NumCacheNodes>
      </CacheCluster>
    </CacheClusters>
  </DescribeCacheClustersResult>
  <ResponseMetadata>
    <RequestId>f270d58f-b7fb-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</DescribeCacheClustersResponse>
```

## See Also
<a name="API_DescribeCacheClusters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeCacheClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeCacheClusters) 

# DescribeCacheEngineVersions
<a name="API_DescribeCacheEngineVersions"></a>

Returns a list of the available cache engines and their versions.

## Request Parameters
<a name="API_DescribeCacheEngineVersions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupFamily **   
The name of a specific cache parameter group family to return details for.  
Valid values are: `memcached1.4` \$1 `memcached1.5` \$1 `memcached1.6` \$1 `redis2.6` \$1 `redis2.8` \$1 `redis3.2` \$1 `redis4.0` \$1 `redis5.0` \$1 `redis6.x` \$1 `redis6.2` \$1 `redis7` \$1 `valkey7`   
Constraints:  
+ Must be 1 to 255 alphanumeric characters
+ First character must be a letter
+ Cannot end with a hyphen or contain two consecutive hyphens
Type: String  
Required: No

 ** DefaultOnly **   
If `true`, specifies that only the default version of the specified engine or engine and major version combination is to be returned.  
Type: Boolean  
Required: No

 ** Engine **   
The cache engine to return. Valid values: `memcached` \$1 `redis`   
Type: String  
Required: No

 ** EngineVersion **   
The cache engine version to return.  
Example: `1.4.14`   
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeCacheEngineVersions_ResponseElements"></a>

The following elements are returned by the service.

 **CacheEngineVersions.CacheEngineVersion.N**   
A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.  
Type: Array of [CacheEngineVersion](API_CacheEngineVersion.md) objects

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

## Errors
<a name="API_DescribeCacheEngineVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeCacheEngineVersions_Examples"></a>

### DescribeCacheEngineVersions
<a name="API_DescribeCacheEngineVersions_Example_1"></a>

This example illustrates one usage of DescribeCacheEngineVersions.

#### Sample Request
<a name="API_DescribeCacheEngineVersions_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeCacheEngineVersions
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeCacheEngineVersions_Example_1_Response"></a>

```
<DescribeCacheEngineVersionsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeCacheEngineVersionsResult>
    <CacheEngineVersions>
      <CacheEngineVersion>
        <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
        <Engine>memcached</Engine>
        <CacheEngineVersionDescription>memcached version 1.4.14</CacheEngineVersionDescription>
        <CacheEngineDescription>memcached</CacheEngineDescription>
        <EngineVersion>1.4.14</EngineVersion>
      </CacheEngineVersion>
      <CacheEngineVersion>
        <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
        <Engine>memcached</Engine>
        <CacheEngineVersionDescription>memcached version 1.4.5</CacheEngineVersionDescription>
        <CacheEngineDescription>memcached</CacheEngineDescription>
        <EngineVersion>1.4.5</EngineVersion>
      </CacheEngineVersion>
    </CacheEngineVersions>
  </DescribeCacheEngineVersionsResult>
  <ResponseMetadata>
    <RequestId>a6ac9ad2-f8a4-11e1-a4d1-a345e5370093</RequestId>
  </ResponseMetadata>
</DescribeCacheEngineVersionsResponse>
```

## See Also
<a name="API_DescribeCacheEngineVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeCacheEngineVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeCacheEngineVersions) 

# DescribeCacheParameterGroups
<a name="API_DescribeCacheParameterGroups"></a>

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

## Request Parameters
<a name="API_DescribeCacheParameterGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupName **   
The name of a specific cache parameter group to return details for.  
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeCacheParameterGroups_ResponseElements"></a>

The following elements are returned by the service.

 **CacheParameterGroups.CacheParameterGroup.N**   
A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.  
Type: Array of [CacheParameterGroup](API_CacheParameterGroup.md) objects

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

## Errors
<a name="API_DescribeCacheParameterGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCacheParameterGroups_Examples"></a>

### DescribeCacheParameterGroups
<a name="API_DescribeCacheParameterGroups_Example_1"></a>

This example illustrates one usage of DescribeCacheParameterGroups.

#### Sample Request
<a name="API_DescribeCacheParameterGroups_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeCacheParameterGroups
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeCacheParameterGroups_Example_1_Response"></a>

```
<DescribeCacheParameterGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeCacheParameterGroupsResult>
    <CacheParameterGroups>
      <CacheParameterGroup>
        <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>
        <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
        <Description>Default parameter group for memcached1.4</Description>
      </CacheParameterGroup>
      <CacheParameterGroup>
        <CacheParameterGroupName>mycacheparametergroup</CacheParameterGroupName>
        <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
        <Description>My cache parameter group</Description>
      </CacheParameterGroup>
      <CacheParameterGroup>
        <CacheParameterGroupName>mycacheparametergroup1</CacheParameterGroupName>
        <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
        <Description>My first cache parameter group</Description>
      </CacheParameterGroup>
      <CacheParameterGroup>
        <CacheParameterGroupName>mycacheparametergroup3</CacheParameterGroupName>
        <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
        <Description>My first cache parameter group</Description>
      </CacheParameterGroup>
    </CacheParameterGroups>
  </DescribeCacheParameterGroupsResult>
  <ResponseMetadata>
    <RequestId>7193fbb8-b7fc-11e0-9b0b-a9261be2b354</RequestId>
  </ResponseMetadata>
</DescribeCacheParameterGroupsResponse>
```

## See Also
<a name="API_DescribeCacheParameterGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeCacheParameterGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeCacheParameterGroups) 

# DescribeCacheParameters
<a name="API_DescribeCacheParameters"></a>

Returns the detailed parameter list for a particular cache parameter group.

## Request Parameters
<a name="API_DescribeCacheParameters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupName **   
The name of a specific cache parameter group to return details for.  
Type: String  
Required: Yes

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

 ** Source **   
The parameter types to return.  
Valid values: `user` \$1 `system` \$1 `engine-default`   
Type: String  
Required: No

## Response Elements
<a name="API_DescribeCacheParameters_ResponseElements"></a>

The following elements are returned by the service.

 **CacheNodeTypeSpecificParameters.CacheNodeTypeSpecificParameter.N**   
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.  
Type: Array of [CacheNodeTypeSpecificParameter](API_CacheNodeTypeSpecificParameter.md) objects

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

 **Parameters.Parameter.N**   
A list of [Parameter](API_Parameter.md) instances.  
Type: Array of [Parameter](API_Parameter.md) objects

## Errors
<a name="API_DescribeCacheParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCacheParameters_Examples"></a>

### DescribeCacheParameters
<a name="API_DescribeCacheParameters_Example_1"></a>

Some of the output has been omitted for brevity.

#### Sample Request
<a name="API_DescribeCacheParameters_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeCacheParameters
   &CacheParameterGroupName=default.memcached1.4
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeCacheParameters_Example_1_Response"></a>

```
<DescribeCacheParametersResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeCacheParametersResult>
    <CacheNodeTypeSpecificParameters>
      <CacheNodeTypeSpecificParameter>
        <CacheNodeTypeSpecificValues>
          <CacheNodeTypeSpecificValue>
            <CacheNodeType>cache.c1.xlarge</CacheNodeType>
            <Value>6000</Value>
          </CacheNodeTypeSpecificValue>
         
 (...output omitted...)

        </CacheNodeTypeSpecificValues>
        <DataType>integer</DataType>
        <Source>system</Source>
        <IsModifiable>false</IsModifiable>
        <Description>The maximum configurable amount of memory to use to store items, in megabytes.</Description>
        <AllowedValues>1-100000</AllowedValues>
        <ParameterName>max_cache_memory</ParameterName>
        <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
      </CacheNodeTypeSpecificParameter>
      <CacheNodeTypeSpecificParameter>
          
 (...output omitted...)

      </CacheNodeTypeSpecificParameter>
    </CacheNodeTypeSpecificParameters>
    <Parameters>
      <Parameter>
        <ParameterValue>1024</ParameterValue>
        <DataType>integer</DataType>
        <Source>system</Source>
        <IsModifiable>false</IsModifiable>
        <Description>The backlog queue limit.</Description>
        <AllowedValues>1-10000</AllowedValues>
        <ParameterName>backlog_queue_limit</ParameterName>
        <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
      </Parameter>
 
 (...output omitted...)
      
    </Parameters>
  </DescribeCacheParametersResult>
  <ResponseMetadata>
    <RequestId>0c507368-b7fe-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</DescribeCacheParametersResponse>
```

## See Also
<a name="API_DescribeCacheParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeCacheParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeCacheParameters) 

# DescribeCacheSecurityGroups
<a name="API_DescribeCacheSecurityGroups"></a>

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. This applicable only when you have ElastiCache in Classic setup 

## Request Parameters
<a name="API_DescribeCacheSecurityGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSecurityGroupName **   
The name of the cache security group to return details for.  
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeCacheSecurityGroups_ResponseElements"></a>

The following elements are returned by the service.

 **CacheSecurityGroups.CacheSecurityGroup.N**   
A list of cache security groups. Each element in the list contains detailed information about one group.  
Type: Array of [CacheSecurityGroup](API_CacheSecurityGroup.md) objects

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

## Errors
<a name="API_DescribeCacheSecurityGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DescribeCacheSecurityGroups_Examples"></a>

### DescribeCacheSecurityGroups
<a name="API_DescribeCacheSecurityGroups_Example_1"></a>

This example illustrates one usage of DescribeCacheSecurityGroups.

#### Sample Request
<a name="API_DescribeCacheSecurityGroups_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeCacheSecurityGroups
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeCacheSecurityGroups_Example_1_Response"></a>

```
<DescribeCacheSecurityGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeCacheSecurityGroupsResult>
    <CacheSecurityGroups>
      <CacheSecurityGroup>
        <EC2SecurityGroups/>
        <CacheSecurityGroupName>default</CacheSecurityGroupName>
        <OwnerId>123456789012</OwnerId>
        <Description>default</Description>
      </CacheSecurityGroup>
      <CacheSecurityGroup>
        <EC2SecurityGroups/>
        <CacheSecurityGroupName>mycachesecuritygroup</CacheSecurityGroupName>
        <OwnerId>123456789012</OwnerId>
        <Description>My Security Group</Description>
      </CacheSecurityGroup>
    </CacheSecurityGroups>
  </DescribeCacheSecurityGroupsResult>
  <ResponseMetadata>
    <RequestId>a95360ae-b7fc-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</DescribeCacheSecurityGroupsResponse>
```

## See Also
<a name="API_DescribeCacheSecurityGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeCacheSecurityGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeCacheSecurityGroups) 

# DescribeCacheSubnetGroups
<a name="API_DescribeCacheSubnetGroups"></a>

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. 

## Request Parameters
<a name="API_DescribeCacheSubnetGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSubnetGroupName **   
The name of the cache subnet group to return details for.  
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeCacheSubnetGroups_ResponseElements"></a>

The following elements are returned by the service.

 **CacheSubnetGroups.CacheSubnetGroup.N**   
A list of cache subnet groups. Each element in the list contains detailed information about one group.  
Type: Array of [CacheSubnetGroup](API_CacheSubnetGroup.md) objects

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

## Errors
<a name="API_DescribeCacheSubnetGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeCacheSubnetGroups_Examples"></a>

### DescribeCacheSubnetGroups
<a name="API_DescribeCacheSubnetGroups_Example_1"></a>

Some of the output has been omitted for brevity.

#### Sample Request
<a name="API_DescribeCacheSubnetGroups_Example_1_Request"></a>

```
https://elasticache.amazonaws.com/
   ?Action=DescribeCacheSubnetGroups
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeCacheSubnetGroups_Example_1_Response"></a>

```
<DescribeCacheSubnetGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
        <DescribeCacheSubnetGroupsResult>
            <CacheSubnetGroups>
                <CacheSubnetGroup>
                    <VpcId>990524496922</VpcId>
                    <CacheSubnetGroupDescription>description</CacheSubnetGroupDescription>
                    <CacheSubnetGroupName>subnet_grp1</CacheSubnetGroupName>
                    <Subnets>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-west-2c</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-west-2b</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-west-2c</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                    </Subnets>
                </CacheSubnetGroup>
                
 (...output omitted...)
      
            </CacheSubnetGroups>
        </DescribeCacheSubnetGroupsResult>
        <ResponseMetadata>
            <RequestId>31d0faee-229b-11e1-81f1-df3a2a803dad</RequestId>
        </ResponseMetadata>
    </DescribeCacheSubnetGroupsResponse>
```

## See Also
<a name="API_DescribeCacheSubnetGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeCacheSubnetGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeCacheSubnetGroups) 

# DescribeEngineDefaultParameters
<a name="API_DescribeEngineDefaultParameters"></a>

Returns the default engine and system parameter information for the specified cache engine.

## Request Parameters
<a name="API_DescribeEngineDefaultParameters_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupFamily **   
The name of the cache parameter group family.  
Valid values are: `memcached1.4` \$1 `memcached1.5` \$1 `memcached1.6` \$1 `redis2.6` \$1 `redis2.8` \$1 `redis3.2` \$1 `redis4.0` \$1 `redis5.0` \$1 `redis6.x` \$1 `redis6.2` \$1 `redis7`   
Type: String  
Required: Yes

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

## Response Elements
<a name="API_DescribeEngineDefaultParameters_ResponseElements"></a>

The following element is returned by the service.

 ** EngineDefaults **   
Represents the output of a `DescribeEngineDefaultParameters` operation.  
Type: [EngineDefaults](API_EngineDefaults.md) object

## Errors
<a name="API_DescribeEngineDefaultParameters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DescribeEngineDefaultParameters_Examples"></a>

### DescribeEngineDefaultParameters
<a name="API_DescribeEngineDefaultParameters_Example_1"></a>

Some of the output has been omitted for brevity.

#### Sample Request
<a name="API_DescribeEngineDefaultParameters_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeEngineDefaultParameters
   &CacheParameterGroupFamily=memcached1.4
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeEngineDefaultParameters_Example_1_Response"></a>

```
<DescribeEngineDefaultParametersResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeEngineDefaultParametersResult>
    <EngineDefaults>
      <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
      <Parameters>
        <Parameter>
          <ParameterValue>1024</ParameterValue>
          <DataType>integer</DataType>
          <Source>system</Source>
          <IsModifiable>false</IsModifiable>
          <Description>The backlog queue limit.</Description>
          <AllowedValues>1-10000</AllowedValues>
          <ParameterName>backlog_queue_limit</ParameterName>
          <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
        </Parameter>
        <Parameter>
                
 (...output omitted...)
          
        </Parameter>
      </Parameters>
      <CacheNodeTypeSpecificParameters>
        <CacheNodeTypeSpecificParameter>
          <CacheNodeTypeSpecificValues>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.c1.xlarge</CacheNodeType>
              <Value>6000</Value>
            </CacheNodeTypeSpecificValue>
               
 (...output omitted...)
          
          </CacheNodeTypeSpecificValues>
          <DataType>integer</DataType>
          <Source>system</Source>
          <IsModifiable>false</IsModifiable>
          <Description>The maximum configurable amount of memory to use to store items, in megabytes.</Description>
          <AllowedValues>1-100000</AllowedValues>
          <ParameterName>max_cache_memory</ParameterName>
          <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
        </CacheNodeTypeSpecificParameter>
               
 (...output omitted...)
          
      </CacheNodeTypeSpecificParameters>
    </EngineDefaults>
  </DescribeEngineDefaultParametersResult>
  <ResponseMetadata>
    <RequestId>061282fe-b7fd-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</DescribeEngineDefaultParametersResponse>
```

## See Also
<a name="API_DescribeEngineDefaultParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeEngineDefaultParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeEngineDefaultParameters) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

## Request Parameters
<a name="API_DescribeEvents_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Duration **   
The number of minutes worth of events to retrieve.  
Type: Integer  
Required: No

 ** EndTime **   
The end of the time interval for which to retrieve events, specified in ISO 8601 format.  
 **Example:** 2017-03-30T07:03:49.555Z  
Type: Timestamp  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

 ** SourceIdentifier **   
The identifier of the event source for which events are returned. If not specified, all sources are included in the response.  
Type: String  
Required: No

 ** SourceType **   
The event source to retrieve events for. If no value is specified, all events are returned.  
Type: String  
Valid Values: `cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group | replication-group | serverless-cache | serverless-cache-snapshot | user | user-group`   
Required: No

 ** StartTime **   
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.  
 **Example:** 2017-03-30T07:03:49.555Z  
Type: Timestamp  
Required: No

## Response Elements
<a name="API_DescribeEvents_ResponseElements"></a>

The following elements are returned by the service.

 **Events.Event.N**   
A list of events. Each element in the list contains detailed information about one event.  
Type: Array of [Event](API_Event.md) objects

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

## Errors
<a name="API_DescribeEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_DescribeEvents_Examples"></a>

### DescribeEvents
<a name="API_DescribeEvents_Example_1"></a>

Some of the output has been omitted for brevity.

#### Sample Request
<a name="API_DescribeEvents_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeEvents
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeEvents_Example_1_Response"></a>

```
<DescribeEventsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
    <DescribeEventsResult> 
        <Events> 
            <Event> 
                <Message>Cache cluster created</Message> 
                <SourceType>cache-cluster</SourceType> 
                <Date>2015-02-02T18:22:18.202Z</Date> 
                <SourceIdentifier>my-redis-primary</SourceIdentifier> 
            </Event> 
               
 (...output omitted...)
          
        </Events> 
    </DescribeEventsResult> 
    <ResponseMetadata> 
        <RequestId>e21c81b4-b9cd-11e3-8a16-7978bb24ffdf</RequestId> 
    </ResponseMetadata> 
</DescribeEventsResponse>
```

## See Also
<a name="API_DescribeEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeEvents) 

# DescribeGlobalReplicationGroups
<a name="API_DescribeGlobalReplicationGroups"></a>

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. 

## Request Parameters
<a name="API_DescribeGlobalReplicationGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.   
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.   
Type: Integer  
Required: No

 ** ShowMemberInfo **   
Returns the list of members that comprise the Global datastore.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DescribeGlobalReplicationGroups_ResponseElements"></a>

The following elements are returned by the service.

 **GlobalReplicationGroups.GlobalReplicationGroup.N**   
Indicates the slot configuration and global identifier for each slice group.  
Type: Array of [GlobalReplicationGroup](API_GlobalReplicationGroup.md) objects

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >  
Type: String

## Errors
<a name="API_DescribeGlobalReplicationGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_DescribeGlobalReplicationGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeGlobalReplicationGroups) 

# DescribeReplicationGroups
<a name="API_DescribeReplicationGroups"></a>

Returns information about a particular replication group. If no identifier is specified, `DescribeReplicationGroups` returns information about all replication groups.

**Note**  
This operation is valid for Valkey or Redis OSS only.

## Request Parameters
<a name="API_DescribeReplicationGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

 ** ReplicationGroupId **   
The identifier for the replication group to be described. This parameter is not case sensitive.  
If you do not specify this parameter, information about all replication groups is returned.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeReplicationGroups_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

 **ReplicationGroups.ReplicationGroup.N**   
A list of replication groups. Each item in the list contains detailed information about one replication group.  
Type: Array of [ReplicationGroup](API_ReplicationGroup.md) objects

## Errors
<a name="API_DescribeReplicationGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeReplicationGroups_Examples"></a>

### DescribeReplicationGroups
<a name="API_DescribeReplicationGroups_Example_1"></a>

This example illustrates one usage of DescribeReplicationGroups.

#### Sample Request
<a name="API_DescribeReplicationGroups_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeReplicationGroups
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeReplicationGroups_Example_1_Response"></a>

```
<DescribeReplicationGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <DescribeReplicationGroupsResult> 
      <ReplicationGroups> 
         <ReplicationGroup> 
            <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> 
            <MemberClusters> 
               <ClusterId>my-redis-primary</ClusterId> 
            </MemberClusters> 
            <NodeGroups> 
               <NodeGroup> 
                  <NodeGroupId>0001</NodeGroupId> 
                  <PrimaryEndpoint> 
                     <Port>6379</Port> 
                     <Address>my-repgroup.q68zge.ng.0001.use1devo.elmo-dev.amazonaws.com</Address> 
                  </PrimaryEndpoint> 
                  <Status>available</Status> 
                  <NodeGroupMembers> 
                     <NodeGroupMember> 
                        <CacheClusterId>my-redis-primary</CacheClusterId> 
                        <ReadEndpoint> 
                           <Port>6379</Port> 
                           <Address>my-redis-primary.q68zge.0001.use1devo.elmo-dev.amazonaws.com</Address> 
                        </ReadEndpoint> 
                        <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone> 
                        <CacheNodeId>0001</CacheNodeId> 
                        <CurrentRole>primary</CurrentRole> 
                     </NodeGroupMember> 
                  </NodeGroupMembers> 
               </NodeGroup> 
            </NodeGroups> 
            <ReplicationGroupId>my-repgroup</ReplicationGroupId> 
            <Status>available</Status> 
            <PendingModifiedValues /> 
            <Description>My replication group</Description> 
         </ReplicationGroup> 
      </ReplicationGroups> 
   </DescribeReplicationGroupsResult> 
   <ResponseMetadata> 
      <RequestId>144745b0-b9d3-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</DescribeReplicationGroupsResponse>
```

## See Also
<a name="API_DescribeReplicationGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeReplicationGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeReplicationGroups) 

# DescribeReservedCacheNodes
<a name="API_DescribeReservedCacheNodes"></a>

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

## Request Parameters
<a name="API_DescribeReservedCacheNodes_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheNodeType **   
The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.  
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.  
+ General purpose:
  + Current generation: 

     **M7g node types**: `cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge` 

     **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge` 

     **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` 

     **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` 

     **T3 node types:** `cache.t3.micro`, `cache.t3.small`, `cache.t3.medium` 

     **T2 node types:** `cache.t2.micro`, `cache.t2.small`, `cache.t2.medium` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **T1 node types:** `cache.t1.micro` 

     **M1 node types:** `cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge` 

     **M3 node types:** `cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge` 
+ Compute optimized:
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **C1 node types:** `cache.c1.xlarge` 
+ Memory optimized:
  + Current generation: 

     **R7g node types**: `cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge` 

     **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge` 

     **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge` 

     **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` 
 **Additional node type info**   
+ All current generation instance types are created in Amazon VPC by default.
+ Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
+ Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
+ The configuration variables `appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
Type: String  
Required: No

 ** Duration **   
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.  
Valid Values: `1 | 3 | 31536000 | 94608000`   
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

 ** OfferingType **   
The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.  
Valid values: `"Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"`   
Type: String  
Required: No

 ** ProductDescription **   
The product description filter value. Use this parameter to show only those reservations matching the specified product description.  
Type: String  
Required: No

 ** ReservedCacheNodeId **   
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.  
Type: String  
Required: No

 ** ReservedCacheNodesOfferingId **   
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeReservedCacheNodes_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

 **ReservedCacheNodes.ReservedCacheNode.N**   
A list of reserved cache nodes. Each element in the list contains detailed information about one node.  
Type: Array of [ReservedCacheNode](API_ReservedCacheNode.md) objects

## Errors
<a name="API_DescribeReservedCacheNodes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ReservedCacheNodeNotFound **   
The requested reserved cache node was not found.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeReservedCacheNodes_Examples"></a>

### DescribeReservedCacheNodes
<a name="API_DescribeReservedCacheNodes_Example_1"></a>

This example illustrates one usage of DescribeReservedCacheNodes.

#### Sample Request
<a name="API_DescribeReservedCacheNodes_Example_1_Request"></a>

```
https://elasticache.amazonaws.com/
   ?Action=DescribeReservedCacheNodes
   &ReservedCacheNodeId=customerSpecifiedID
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeReservedCacheNodes_Example_1_Response"></a>

```
<DescribeReservedCacheNodesResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeReservedCacheNodesResult>
    <ReservedCacheNodes>
      <ReservedCacheNode>
        <OfferingType>Medium Utilization</OfferingType>
        <RecurringCharges/>
        <ProductDescription>memcached</ProductDescription>
        <ReservedCacheNodesOfferingId>649fd0c8-cf6d-47a0-bfa6-060f8e75e95f</ReservedCacheNodesOfferingId>
        <State>payment-failed</State>
        <ReservedCacheNodeId>myreservationid</ReservedCacheNodeId>
        <CacheNodeCount>1</CacheNodeCount>
        <StartTime>2010-12-15T00:25:14.131Z</StartTime>
        <Duration>31536000</Duration>
        <FixedPrice>227.5</FixedPrice>
        <UsagePrice>0.046</UsagePrice>
        <CacheNodeType>cache.m1.small</CacheNodeType>
      </ReservedCacheNode>
  </DescribeReservedCacheNodesResult>
  <ResponseMetadata>
    <RequestId>c695119b-2961-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</DescribeReservedCacheNodesResponse>
```

## See Also
<a name="API_DescribeReservedCacheNodes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeReservedCacheNodes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeReservedCacheNodes) 

# DescribeReservedCacheNodesOfferings
<a name="API_DescribeReservedCacheNodesOfferings"></a>

Lists available reserved cache node offerings.

## Request Parameters
<a name="API_DescribeReservedCacheNodesOfferings_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheNodeType **   
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.  
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.  
+ General purpose:
  + Current generation: 

     **M7g node types**: `cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge` 

     **M5 node types:** `cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge` 

     **M4 node types:** `cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge` 

     **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): `cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium` 

     **T3 node types:** `cache.t3.micro`, `cache.t3.small`, `cache.t3.medium` 

     **T2 node types:** `cache.t2.micro`, `cache.t2.small`, `cache.t2.medium` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **T1 node types:** `cache.t1.micro` 

     **M1 node types:** `cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge` 

     **M3 node types:** `cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge` 
+ Compute optimized:
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **C1 node types:** `cache.c1.xlarge` 
+ Memory optimized:
  + Current generation: 

     **R7g node types**: `cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge` 
**Note**  
For region availability, see [Supported Node Types](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) 

     **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): `cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge` 

     **R5 node types:** `cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge` 

     **R4 node types:** `cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge` 
  + Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

     **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge` 

     **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge` 
 **Additional node type info**   
+ All current generation instance types are created in Amazon VPC by default.
+ Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
+ Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
+ The configuration variables `appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
Type: String  
Required: No

 ** Duration **   
Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.  
Valid Values: `1 | 3 | 31536000 | 94608000`   
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 100  
Constraints: minimum 20; maximum 100.  
Type: Integer  
Required: No

 ** OfferingType **   
The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.  
Valid Values: `"Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"`   
Type: String  
Required: No

 ** ProductDescription **   
The product description filter value. Use this parameter to show only the available offerings matching the specified product description.  
Type: String  
Required: No

 ** ReservedCacheNodesOfferingId **   
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.  
Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706`   
Type: String  
Required: No

## Response Elements
<a name="API_DescribeReservedCacheNodesOfferings_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
Provides an identifier to allow retrieval of paginated results.  
Type: String

 **ReservedCacheNodesOfferings.ReservedCacheNodesOffering.N**   
A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.  
Type: Array of [ReservedCacheNodesOffering](API_ReservedCacheNodesOffering.md) objects

## Errors
<a name="API_DescribeReservedCacheNodesOfferings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ReservedCacheNodesOfferingNotFound **   
The requested cache node offering does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeReservedCacheNodesOfferings_Examples"></a>

### DescribeReservedCacheNodesOfferings
<a name="API_DescribeReservedCacheNodesOfferings_Example_1"></a>

This example illustrates one usage of DescribeReservedCacheNodesOfferings.

#### Sample Request
<a name="API_DescribeReservedCacheNodesOfferings_Example_1_Request"></a>

```
https://elasticache.amazonaws.com/
   ?Action=DescribeReservedCacheNodesOfferings
   &ReservedCacheNodesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeReservedCacheNodesOfferings_Example_1_Response"></a>

```
<DescribeReservedCacheNodesOfferingsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeReservedCacheNodesOfferingsResult>
    <ReservedCacheNodesOfferings>
      <ReservedCacheNodesOffering>
        <Duration>31536000</Duration>
        <OfferingType>Heavy Utilization</OfferingType>
        <RecurringCharges>
          <RecurringCharge>
            <RecurringChargeFrequency>Hourly</RecurringChargeFrequency>
            <RecurringChargeAmount>0.123</RecurringChargeAmount>
          </RecurringCharge>
        </RecurringCharges>
        <FixedPrice>162.0</FixedPrice>
        <ProductDescription>memcached</ProductDescription>
        <UsagePrice>0.0</UsagePrice>
        <ReservedCacheNodesOfferingId>SampleOfferingId</ReservedCacheNodesOfferingId>
        <CacheNodeType>cache.m1.small</CacheNodeType>
      </ReservedCacheNodesOffering>
    </ReservedCacheNodesOfferings>
  </DescribeReservedCacheNodesOfferingsResult>
  <ResponseMetadata>
    <RequestId>521b420a-2961-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</DescribeReservedCacheNodesOfferingsResponse>
```

## See Also
<a name="API_DescribeReservedCacheNodesOfferings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings) 

# DescribeServerlessCaches
<a name="API_DescribeServerlessCaches"></a>

Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this AWS account.

## Request Parameters
<a name="API_DescribeServerlessCaches_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
The maximum number of records in the response. If more records exist than the specified max-records value, the next token is included in the response so that remaining results can be retrieved. The default is 50.  
Type: Integer  
Required: No

 ** NextToken **   
An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.  
Type: String  
Required: No

 ** ServerlessCacheName **   
The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeServerlessCaches_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.  
Type: String

 **ServerlessCaches.member.N**   
The serverless caches associated with a given description request.  
Type: Array of [ServerlessCache](API_ServerlessCache.md) objects

## Errors
<a name="API_DescribeServerlessCaches_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeServerlessCaches_Examples"></a>

### DescribeServerlessCaches
<a name="API_DescribeServerlessCaches_Example_1"></a>

This example illustrates one usage of DescribeServerlessCaches.

#### Sample Request
<a name="API_DescribeServerlessCaches_Example_1_Request"></a>

```
{
    "input": {
    },
    "output": {
        "ServerlessCaches": [
            {
                "ServerlessCacheName": "my-serverless-cache",
                "Description": "A serverless cache.",
                "Status": "available",
                "Engine": "redis",
                "MajorEngineVersion": "7",
                "FullEngineVersion": "7.0",
                "SubnetIds": [
                    "subnet-xxx8c982",
                    "subnet-xxx382f3",
                    "subnet-xxxb3e7c0"
                ],
                "CacheUsageLimits": {
                    "DataStorage" : {
                        "Maximum" : 10, 
                        "Unit" : "GB"
                    }, 
                    "ECPUPerSecond" : {
                        "Maximum" : 50000
                    }
                },
                "SecurityGroupIds": [
                    "sg-xxx0c9af"
                ],
                "Endpoint": {
                    "Address": "my-serverless-cache-xxxxxx.serverless.use1qa.cache.amazonaws.com",
                    "Port": 6379
                },
                "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
                "SnapshotRetentionLimit": 10,
                "DailySnapshotTime": "11:00",
                "NetworkType": "ipv4"
            }
        ]
    }
}
```

## See Also
<a name="API_DescribeServerlessCaches_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeServerlessCaches) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeServerlessCaches) 

# DescribeServerlessCacheSnapshots
<a name="API_DescribeServerlessCacheSnapshots"></a>

Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

## Request Parameters
<a name="API_DescribeServerlessCacheSnapshots_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.  
Type: Integer  
Required: No

 ** NextToken **   
An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: No

 ** ServerlessCacheName **   
The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: No

 ** ServerlessCacheSnapshotName **   
The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: No

 ** SnapshotType **   
The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeServerlessCacheSnapshots_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: String

 **ServerlessCacheSnapshots.ServerlessCacheSnapshot.N**   
The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: Array of [ServerlessCacheSnapshot](API_ServerlessCacheSnapshot.md) objects

## Errors
<a name="API_DescribeServerlessCacheSnapshots_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServerlessCacheSnapshotNotFoundFault **   
This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeServerlessCacheSnapshots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeServerlessCacheSnapshots) 

# DescribeServiceUpdates
<a name="API_DescribeServiceUpdates"></a>

Returns details of the service updates

## Request Parameters
<a name="API_DescribeServiceUpdates_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response  
Type: Integer  
Required: No

 ** ServiceUpdateName **   
The unique ID of the service update  
Type: String  
Required: No

 **ServiceUpdateStatus.member.N**   
The status of the service update  
Type: Array of strings  
Array Members: Maximum number of 3 items.  
Valid Values: `available | cancelled | expired`   
Required: No

## Response Elements
<a name="API_DescribeServiceUpdates_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **ServiceUpdates.ServiceUpdate.N**   
A list of service updates  
Type: Array of [ServiceUpdate](API_ServiceUpdate.md) objects

## Errors
<a name="API_DescribeServiceUpdates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ServiceUpdateNotFoundFault **   
The service update doesn't exist  
HTTP Status Code: 404

## See Also
<a name="API_DescribeServiceUpdates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeServiceUpdates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeServiceUpdates) 

# DescribeSnapshots
<a name="API_DescribeSnapshots"></a>

Returns information about cluster or replication group snapshots. By default, `DescribeSnapshots` lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

**Note**  
This operation is valid for Valkey or Redis OSS only.

## Request Parameters
<a name="API_DescribeSnapshots_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheClusterId **   
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.  
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.  
Default: 50  
Constraints: minimum 20; maximum 50.  
Type: Integer  
Required: No

 ** ReplicationGroupId **   
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.  
Type: String  
Required: No

 ** ShowNodeGroupConfig **   
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.  
Type: Boolean  
Required: No

 ** SnapshotName **   
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.  
Type: String  
Required: No

 ** SnapshotSource **   
If set to `system`, the output shows snapshots that were automatically created by ElastiCache. If set to `user` the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeSnapshots_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **Snapshots.Snapshot.N**   
A list of snapshots. Each item in the list contains detailed information about one snapshot.  
Type: Array of [Snapshot](API_Snapshot.md) objects

## Errors
<a name="API_DescribeSnapshots_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** SnapshotNotFoundFault **   
The requested snapshot name does not refer to an existing snapshot.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeSnapshots_Examples"></a>

### DescribeSnapshots
<a name="API_DescribeSnapshots_Example_1"></a>

This example illustrates one usage of DescribeSnapshots.

#### Sample Request
<a name="API_DescribeSnapshots_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeSnapshots
   &MaxRecords=50
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_DescribeSnapshots_Example_1_Response"></a>

```
<DescribeSnapshotsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <DescribeSnapshotsResult> 
      <Snapshots> 
         <Snapshot> 
            <CacheClusterId>my-redis-primary</CacheClusterId> 
            <Port>6379</Port> 
            <CacheNodeType>cache.m1.small</CacheNodeType> 
            <CacheParameterGroupName>default.redis2.8</CacheParameterGroupName> 
            <Engine>redis</Engine> 
            <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone> 
            <CacheClusterCreateTime>2015-02-02T18:46:57.972Z</CacheClusterCreateTime> 
            <EngineVersion>2.8.6</EngineVersion> 
            <SnapshotSource>manual</SnapshotSource> 
            <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
            <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> 
            <SnapshotName>my-manual-snapshot</SnapshotName> 
            <SnapshotRetentionLimit>5</SnapshotRetentionLimit> 
            <NodeSnapshots> 
               <NodeSnapshot> 
                  <SnapshotCreateTime>2015-02-02T18:54:12Z</SnapshotCreateTime> 
                  <CacheNodeCreateTime>2015-02-02T18:46:57.972Z</CacheNodeCreateTime> 
                  <CacheNodeId>0001</CacheNodeId> 
                  <CacheSize>3 MB</CacheSize> 
               </NodeSnapshot> 
            </NodeSnapshots> 
            <SnapshotStatus>creating</SnapshotStatus> 
            <NumCacheNodes>1</NumCacheNodes> 
            <SnapshotWindow>07:30-08:30</SnapshotWindow> 
         </Snapshot> 
      </Snapshots> 
   </DescribeSnapshotsResult> 
   <ResponseMetadata> 
      <RequestId>51b0b25e-b9cf-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</DescribeSnapshotsResponse>
```

## See Also
<a name="API_DescribeSnapshots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeSnapshots) 

# DescribeUpdateActions
<a name="API_DescribeUpdateActions"></a>

Returns details of the update actions 

## Request Parameters
<a name="API_DescribeUpdateActions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **CacheClusterIds.member.N**   
The cache cluster IDs  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Required: No

 ** Engine **   
The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.  
Type: String  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response  
Type: Integer  
Required: No

 **ReplicationGroupIds.member.N**   
The replication group IDs  
Type: Array of strings  
Array Members: Maximum number of 20 items.  
Required: No

 ** ServiceUpdateName **   
The unique ID of the service update  
Type: String  
Required: No

 **ServiceUpdateStatus.member.N**   
The status of the service update  
Type: Array of strings  
Array Members: Maximum number of 3 items.  
Valid Values: `available | cancelled | expired`   
Required: No

 ** ServiceUpdateTimeRange **   
The range of time specified to search for service updates that are in available status  
Type: [TimeRangeFilter](API_TimeRangeFilter.md) object  
Required: No

 ** ShowNodeLevelUpdateStatus **   
Dictates whether to include node level update status in the response   
Type: Boolean  
Required: No

 **UpdateActionStatus.member.N**   
The status of the update action.  
Type: Array of strings  
Array Members: Maximum number of 9 items.  
Valid Values: `not-applied | waiting-to-start | in-progress | stopping | stopped | complete | scheduling | scheduled | not-applicable`   
Required: No

## Response Elements
<a name="API_DescribeUpdateActions_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.  
Type: String

 **UpdateActions.UpdateAction.N**   
Returns a list of update actions  
Type: Array of [UpdateAction](API_UpdateAction.md) objects

## Errors
<a name="API_DescribeUpdateActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_DescribeUpdateActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeUpdateActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeUpdateActions) 

# DescribeUserGroups
<a name="API_DescribeUserGroups"></a>

Returns a list of user groups.

## Request Parameters
<a name="API_DescribeUserGroups_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.   
Type: Integer  
Required: No

 ** UserGroupId **   
The ID of the user group.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeUserGroups_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.>  
Type: String

 **UserGroups.member.N**   
Returns a list of user groups.  
Type: Array of [UserGroup](API_UserGroup.md) objects

## Errors
<a name="API_DescribeUserGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

## See Also
<a name="API_DescribeUserGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeUserGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeUserGroups) 

# DescribeUsers
<a name="API_DescribeUsers"></a>

Returns a list of users.

## Request Parameters
<a name="API_DescribeUsers_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Engine **   
The engine.   
Type: String  
Pattern: `[a-zA-Z]*`   
Required: No

 **Filters.member.N**   
Filter to determine the list of User IDs to return.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >  
Type: String  
Required: No

 ** MaxRecords **   
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.   
Type: Integer  
Required: No

 ** UserId **   
The ID of the user.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: No

## Response Elements
<a name="API_DescribeUsers_ResponseElements"></a>

The following elements are returned by the service.

 ** Marker **   
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >  
Type: String

 **Users.member.N**   
A list of users.  
Type: Array of [User](API_User.md) objects

## Errors
<a name="API_DescribeUsers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeUsers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DescribeUsers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DescribeUsers) 

# DisassociateGlobalReplicationGroup
<a name="API_DisassociateGlobalReplicationGroup"></a>

Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.

## Request Parameters
<a name="API_DisassociateGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: Yes

 ** ReplicationGroupId **   
The name of the secondary cluster you wish to remove from the Global datastore  
Type: String  
Required: Yes

 ** ReplicationGroupRegion **   
The Amazon region of secondary cluster you wish to remove from the Global datastore  
Type: String  
Required: Yes

## Response Elements
<a name="API_DisassociateGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_DisassociateGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_DisassociateGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/DisassociateGlobalReplicationGroup) 

# ExportServerlessCacheSnapshot
<a name="API_ExportServerlessCacheSnapshot"></a>

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.

## Request Parameters
<a name="API_ExportServerlessCacheSnapshot_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** S3BucketName **   
Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Valkey and Redis OSS only.  
Type: String  
Required: Yes

 ** ServerlessCacheSnapshotName **   
The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.  
Type: String  
Required: Yes

## Response Elements
<a name="API_ExportServerlessCacheSnapshot_ResponseElements"></a>

The following element is returned by the service.

 ** ServerlessCacheSnapshot **   
The state of a serverless cache at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: [ServerlessCacheSnapshot](API_ServerlessCacheSnapshot.md) object

## Errors
<a name="API_ExportServerlessCacheSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidServerlessCacheSnapshotStateFault **   
The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** ServerlessCacheSnapshotNotFoundFault **   
This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 404

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ExportServerlessCacheSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ExportServerlessCacheSnapshot) 

# FailoverGlobalReplicationGroup
<a name="API_FailoverGlobalReplicationGroup"></a>

Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.

## Request Parameters
<a name="API_FailoverGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: Yes

 ** PrimaryRegion **   
The Amazon region of the primary cluster of the Global datastore  
Type: String  
Required: Yes

 ** PrimaryReplicationGroupId **   
The name of the primary replication group  
Type: String  
Required: Yes

## Response Elements
<a name="API_FailoverGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_FailoverGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_FailoverGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/FailoverGlobalReplicationGroup) 

# IncreaseNodeGroupsInGlobalReplicationGroup
<a name="API_IncreaseNodeGroupsInGlobalReplicationGroup"></a>

Increase the number of node groups in the Global datastore

## Request Parameters
<a name="API_IncreaseNodeGroupsInGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyImmediately **   
Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.  
Type: Boolean  
Required: Yes

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: Yes

 ** NodeGroupCount **   
Total number of node groups you want  
Type: Integer  
Required: Yes

 **RegionalConfigurations.RegionalConfiguration.N**   
Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore  
Type: Array of [RegionalConfiguration](API_RegionalConfiguration.md) objects  
Required: No

## Response Elements
<a name="API_IncreaseNodeGroupsInGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_IncreaseNodeGroupsInGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_IncreaseNodeGroupsInGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/IncreaseNodeGroupsInGlobalReplicationGroup) 

# IncreaseReplicaCount
<a name="API_IncreaseReplicaCount"></a>

Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

## Request Parameters
<a name="API_IncreaseReplicaCount_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyImmediately **   
If `True`, the number of replica nodes is increased immediately. `ApplyImmediately=False` is not currently supported.  
Type: Boolean  
Required: Yes

 ** ReplicationGroupId **   
The id of the replication group to which you want to add replica nodes.  
Type: String  
Required: Yes

 ** NewReplicaCount **   
The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.  
Type: Integer  
Required: No

 **ReplicaConfiguration.ConfigureShard.N**   
A list of `ConfigureShard` objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The `ConfigureShard` has three members: `NewReplicaCount`, `NodeGroupId`, and `PreferredAvailabilityZones`.  
Type: Array of [ConfigureShard](API_ConfigureShard.md) objects  
Required: No

## Response Elements
<a name="API_IncreaseReplicaCount_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_IncreaseReplicaCount_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ClusterQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of clusters per customer.  
HTTP Status Code: 400

 ** InsufficientCacheClusterCapacity **   
The requested cache node type is not available in the specified Availability Zone. For more information, see [InsufficientCacheClusterCapacity](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) in the ElastiCache User Guide.  
HTTP Status Code: 400

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidKMSKeyFault **   
The KMS key supplied is not valid.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The VPC network is in an invalid state.  
HTTP Status Code: 400

 ** NodeGroupsPerReplicationGroupQuotaExceeded **   
The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90  
HTTP Status Code: 400

 ** NodeQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.  
HTTP Status Code: 400

 ** NoOperationFault **   
The operation was not performed because no changes were required.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_IncreaseReplicaCount_Examples"></a>

### Example
<a name="API_IncreaseReplicaCount_Example_1"></a>

The following example increases the replica count to 3 in all node groups of `sample-repl-group`.

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=IncreaseReplicaCount
   &ApplyImmediately=True
   &NewReplicaCount=3
   &ReplicationGroupId=sample-repl-group
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

### Example
<a name="API_IncreaseReplicaCount_Example_2"></a>

The following example increases the replica count in two node groups. Because there are multiple node groups, this code only works for Valkey or Redis OSS (cluster mode enabled) replication groups.

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=IncreaseReplicaCount
   &ApplyImmediately=True
   &ReplicaConfiguration.ConfigureShard.1.NodeGroupId=0001
   &ReplicaConfiguration.ConfigureShard.1.NewReplicaCount=2
   &ReplicaConfiguration.ConfigureShard.1.PreferredAvailabilityZones.PreferredAvailabilityZone.1=us-east-1a
   &ReplicaConfiguration.ConfigureShard.1.PreferredAvailabilityZones.PreferredAvailabilityZone.2=us-east-1c
   &ReplicaConfiguration.ConfigureShard.1.PreferredAvailabilityZones.PreferredAvailabilityZone.3=us-east-1b
   &ReplicaConfiguration.ConfigureShard.2.NodeGroupId=0003
   &ReplicaConfiguration.ConfigureShard.2.NewReplicaCount=3
   &ReplicaConfiguration.ConfigureShard.2.PreferredAvailabilityZones.PreferredAvailabilityZone.1=us-east-1a
   &ReplicaConfiguration.ConfigureShard.2.PreferredAvailabilityZones.PreferredAvailabilityZone.2=us-east-1b
   &ReplicaConfiguration.ConfigureShard.2.PreferredAvailabilityZones.PreferredAvailabilityZone.3=us-east-1c
   &ReplicaConfiguration.ConfigureShard.2.PreferredAvailabilityZones.PreferredAvailabilityZone.4=us-east-1c
   &ReplicationGroupId=sample-repl-group
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_IncreaseReplicaCount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/IncreaseReplicaCount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/IncreaseReplicaCount) 

# ListAllowedNodeTypeModifications
<a name="API_ListAllowedNodeTypeModifications"></a>

Lists all available node types that you can scale with your cluster's replication group's current node type.

When you use the `ModifyCacheCluster` or `ModifyReplicationGroup` operations to scale your cluster or replication group, the value of the `CacheNodeType` parameter must be one of the node types returned by this operation.

## Request Parameters
<a name="API_ListAllowedNodeTypeModifications_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheClusterId **   
The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.  
You must provide a value for either the `CacheClusterId` or the `ReplicationGroupId`.
Type: String  
Required: No

 ** ReplicationGroupId **   
The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.  
You must provide a value for either the `CacheClusterId` or the `ReplicationGroupId`.
Type: String  
Required: No

## Response Elements
<a name="API_ListAllowedNodeTypeModifications_ResponseElements"></a>

The following elements are returned by the service.

 **ScaleDownModifications.member.N**   
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Valkey or Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.   
Type: Array of strings

 **ScaleUpModifications.member.N**   
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.  
When scaling up a Valkey or Redis OSS cluster or replication group using `ModifyCacheCluster` or `ModifyReplicationGroup`, use a value from this list for the `CacheNodeType` parameter.  
Type: Array of strings

## Errors
<a name="API_ListAllowedNodeTypeModifications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_ListAllowedNodeTypeModifications_Examples"></a>

### ListAllowedNodeTypeModifications for a Cluster
<a name="API_ListAllowedNodeTypeModifications_Example_1"></a>

The following example request a list of node types you can use to scale `myCluster` up.

#### Sample Request
<a name="API_ListAllowedNodeTypeModifications_Example_1_Request"></a>

```
https://elasticache.us-east-1.amazonaws.com/
   ?Action=ListAllowedNodeTypeModifications
   &CacheClusterId=mycachecluster
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Version=2015-02-02
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

### ListAllowedNodeTypeModifications for a Replication Group
<a name="API_ListAllowedNodeTypeModifications_Example_2"></a>

The following example requests a list of node types you can use to scale `myReplGroup` up.

#### Sample Request
<a name="API_ListAllowedNodeTypeModifications_Example_2_Request"></a>

```
https://elasticache.us-east-1.amazonaws.com/
   ?Action=ListAllowedNodeTypeModifications
   &ReplicationGroupId=myreplgroup
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Version=2015-02-02
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_ListAllowedNodeTypeModifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ListAllowedNodeTypeModifications) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists all tags currently on a named resource.

 A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see [Resource-level permissions](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html).

If the cluster is not in the *available* state, `ListTagsForResource` returns an error.

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceName **   
The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`.  
For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).  
Type: String  
Required: Yes

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

The following element is returned by the service.

 **TagList.Tag.N**   
A list of tags as key-value pairs.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

 ** InvalidARN **   
The requested Amazon Resource Name (ARN) does not refer to an existing resource.  
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidServerlessCacheSnapshotStateFault **   
The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** InvalidServerlessCacheStateFault **   
The account for these credentials is not currently active.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** ReservedCacheNodeNotFound **   
The requested reserved cache node was not found.  
HTTP Status Code: 404

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServerlessCacheSnapshotNotFoundFault **   
This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 404

 ** SnapshotNotFoundFault **   
The requested snapshot name does not refer to an existing snapshot.  
HTTP Status Code: 404

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## Examples
<a name="API_ListTagsForResource_Examples"></a>

### ListTagsForResource
<a name="API_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

#### Sample Request
<a name="API_ListTagsForResource_Example_1_Request"></a>

```
https://elasticache.us-east-1.amazonaws.com/
   ?Action=ListTagsForResource
   &ResourceName=arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Version=2015-02-02
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ListTagsForResource) 

# ModifyCacheCluster
<a name="API_ModifyCacheCluster"></a>

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

## Request Parameters
<a name="API_ModifyCacheCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheClusterId **   
The cluster identifier. This value is stored as a lowercase string.  
Type: String  
Required: Yes

 ** ApplyImmediately **   
If `true`, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the cluster.  
If `false`, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.  
If you perform a `ModifyCacheCluster` before a pending modification is applied, the pending modification is replaced by the newer modification.
Valid values: `true` \$1 `false`   
Default: `false`   
Type: Boolean  
Required: No

 ** AuthToken **   
Reserved parameter. The password used to access a password protected server. This parameter must be specified with the `auth-token-update` parameter. Password constraints:  
+ Must be only printable ASCII characters
+ Must be at least 16 characters and no more than 128 characters in length
+ Cannot contain any of the following characters: '/', '"', or '@', '%'
 For more information, see AUTH password at [AUTH](http://redis.io/commands/AUTH).  
Type: String  
Required: No

 ** AuthTokenUpdateStrategy **   
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the `auth-token` parameter. Possible values:  
+ ROTATE - default, if no update strategy is provided
+ SET - allowed only after ROTATE
+ DELETE - allowed only when transitioning to RBAC
 For more information, see [Authenticating Users with AUTH](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth.html)   
Type: String  
Valid Values: `SET | ROTATE | DELETE`   
Required: No

 ** AutoMinorVersionUpgrade **   
 If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.    
Type: Boolean  
Required: No

 ** AZMode **   
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.  
Valid values: `single-az` \$1 `cross-az`.  
This option is only supported for Memcached clusters.  
You cannot specify `single-az` if the Memcached cluster already has cache nodes in different Availability Zones. If `cross-az` is specified, existing Memcached nodes remain in their current Availability Zone.  
Only newly created nodes are located in different Availability Zones. 
Type: String  
Valid Values: `single-az | cross-az`   
Required: No

 **CacheNodeIdsToRemove.CacheNodeId.N**   
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when `NumCacheNodes` is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of `NumCacheNodes` in the request.  
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this `ModifyCacheCluster` call is 5, you must list 2 (7 - 5) cache node IDs to remove.  
Type: Array of strings  
Required: No

 ** CacheNodeType **   
A valid cache node type that you want to scale this cluster up to.  
Type: String  
Required: No

 ** CacheParameterGroupName **   
The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the `ApplyImmediately` parameter is specified as `true` for this request.  
Type: String  
Required: No

 **CacheSecurityGroupNames.CacheSecurityGroupName.N**   
A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.  
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).  
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".  
Type: Array of strings  
Required: No

 ** Engine **   
The engine type used by the cache cluster. The options are valkey, memcached or redis.  
Type: String  
Required: No

 ** EngineVersion **   
The upgraded version of the cache engine to be run on the cache nodes.  
 **Important:** You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement)), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.   
Type: String  
Required: No

 ** IpDiscovery **   
The network type you choose when modifying a cluster, either `ipv4` \$1 `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](http://aws.amazon.com/ec2/nitro/).  
Type: String  
Valid Values: `ipv4 | ipv6`   
Required: No

 **LogDeliveryConfigurations.LogDeliveryConfigurationRequest.N**   
Specifies the destination, format and type of the logs.  
Type: Array of [LogDeliveryConfigurationRequest](API_LogDeliveryConfigurationRequest.md) objects  
Required: No

 **NewAvailabilityZones.PreferredAvailabilityZone.N**   
This option is only supported on Memcached clusters.
The list of Availability Zones where the new Memcached cache nodes are created.  
This parameter is only valid when `NumCacheNodes` in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.  
Scenarios:  
+  **Scenario 1:** You have 3 active nodes and wish to add 2 nodes. Specify `NumCacheNodes=5` (3 \$1 2) and optionally specify two Availability Zones for the two new nodes.
+  **Scenario 2:** You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify `NumCacheNodes=6` ((3 \$1 2) \$1 1) and optionally specify an Availability Zone for the new node.
+  **Scenario 3:** You want to cancel all pending operations. Specify `NumCacheNodes=3` to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting `NumCacheNodes` to the number of current nodes.  
If `cross-az` is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the **Availability Zone Considerations** section of [Cache Node Considerations for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html).  
 **Impact of new add/remove requests upon pending requests**   
+ Scenario-1
  + Pending Action: Delete
  + New Request: Delete
  + Result: The new delete, pending or immediate, replaces the pending delete.
+ Scenario-2
  + Pending Action: Delete
  + New Request: Create
  + Result: The new create, pending or immediate, replaces the pending delete.
+ Scenario-3
  + Pending Action: Create
  + New Request: Delete
  + Result: The new delete, pending or immediate, replaces the pending create.
+ Scenario-4
  + Pending Action: Create
  + New Request: Create
  + Result: The new create is added to the pending create.
**Important**  
 **Important:** If the new create request is **Apply Immediately - Yes**, all creates are performed immediately. If the new create request is **Apply Immediately - No**, all creates are pending.
Type: Array of strings  
Required: No

 ** NotificationTopicArn **   
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.  
The Amazon SNS topic owner must be same as the cluster owner.
Type: String  
Required: No

 ** NotificationTopicStatus **   
The status of the Amazon SNS notification topic. Notifications are sent only if the status is `active`.  
Valid values: `active` \$1 `inactive`   
Type: String  
Required: No

 ** NumCacheNodes **   
The number of cache nodes that the cluster should have. If the value for `NumCacheNodes` is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.  
If you are removing cache nodes, you must use the `CacheNodeIdsToRemove` parameter to provide the IDs of the specific cache nodes to remove.  
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.  
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see `ApplyImmediately`).  
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the `ModifyCacheCluster` request and set `NumCacheNodes` equal to the number of cache nodes currently in the cluster.
Type: Integer  
Required: No

 ** PreferredMaintenanceWindow **   
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.  
Valid values for `ddd` are:  
+  `sun` 
+  `mon` 
+  `tue` 
+  `wed` 
+  `thu` 
+  `fri` 
+  `sat` 
Example: `sun:23:00-mon:01:30`   
Type: String  
Required: No

 ** ScaleConfig **   
Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.  
Type: [ScaleConfig](API_ScaleConfig.md) object  
Required: No

 **SecurityGroupIds.SecurityGroupId.N**   
Specifies the VPC Security Groups associated with the cluster.  
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).  
Type: Array of strings  
Required: No

 ** SnapshotRetentionLimit **   
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.  
If the value of `SnapshotRetentionLimit` is set to zero (0), backups are turned off.
Type: Integer  
Required: No

 ** SnapshotWindow **   
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.   
Type: String  
Required: No

## Response Elements
<a name="API_ModifyCacheCluster_ResponseElements"></a>

The following element is returned by the service.

 ** CacheCluster **   
Contains all of the attributes of a specific cluster.  
Type: [CacheCluster](API_CacheCluster.md) object

## Errors
<a name="API_ModifyCacheCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** InsufficientCacheClusterCapacity **   
The requested cache node type is not available in the specified Availability Zone. For more information, see [InsufficientCacheClusterCapacity](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) in the ElastiCache User Guide.  
HTTP Status Code: 400

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidCacheSecurityGroupState **   
The current state of the cache security group does not allow deletion.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The VPC network is in an invalid state.  
HTTP Status Code: 400

 ** NodeQuotaForClusterExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.  
HTTP Status Code: 400

 ** NodeQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyCacheCluster_Examples"></a>

### ModifyCacheCluster
<a name="API_ModifyCacheCluster_Example_1"></a>

This example illustrates one usage of ModifyCacheCluster.

#### Sample Request
<a name="API_ModifyCacheCluster_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=ModifyCacheCluster
   NumCacheNodes=5
   &CacheClusterId=simcoprod01
   &ApplyImmediately=true
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_ModifyCacheCluster_Example_1_Response"></a>

```
<ModifyCacheClusterResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <ModifyCacheClusterResult>
    <CacheCluster>
      <CacheParameterGroup>
        <ParameterApplyStatus>in-sync</ParameterApplyStatus>
        <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>
        <CacheNodeIdsToReboot/>
      </CacheParameterGroup>
      <CacheClusterId>simcoprod01</CacheClusterId>
      <CacheClusterStatus>available</CacheClusterStatus>
      <ConfigurationEndpoint>
        <Port>11211</Port>
        <Address>simcoprod01.m2st2p.cfg.cache.amazonaws.com</Address>
      </ConfigurationEndpoint>
      <CacheNodeType>cache.m1.large</CacheNodeType>
      <Engine>memcached</Engine>
      <PendingModifiedValues>
        <NumCacheNodes>5</NumCacheNodes>
      </PendingModifiedValues>
      <PreferredAvailabilityZone>us-west-2b</PreferredAvailabilityZone>
      <CacheClusterCreateTime>2015-02-02T23:45:20.937Z</CacheClusterCreateTime>
      <EngineVersion>1.4.5</EngineVersion>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <PreferredMaintenanceWindow>fri:04:30-fri:05:30</PreferredMaintenanceWindow>
      <CacheSecurityGroups>
        <CacheSecurityGroup>
          <CacheSecurityGroupName>default</CacheSecurityGroupName>
          <Status>active</Status>
        </CacheSecurityGroup>
      </CacheSecurityGroups>
      <NumCacheNodes>3</NumCacheNodes>
    </CacheCluster>
  </ModifyCacheClusterResult>
  <ResponseMetadata>
    <RequestId>d5786c6d-b7fe-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</ModifyCacheClusterResponse>
```

## See Also
<a name="API_ModifyCacheCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyCacheCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyCacheCluster) 

# ModifyCacheParameterGroup
<a name="API_ModifyCacheParameterGroup"></a>

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

## Request Parameters
<a name="API_ModifyCacheParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupName **   
The name of the cache parameter group to modify.  
Type: String  
Required: Yes

 **ParameterNameValues.ParameterNameValue.N**   
An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.  
Type: Array of [ParameterNameValue](API_ParameterNameValue.md) objects  
Required: Yes

## Response Elements
<a name="API_ModifyCacheParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** CacheParameterGroupName **   
The name of the cache parameter group.  
Type: String

## Errors
<a name="API_ModifyCacheParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** InvalidCacheParameterGroupState **   
The current state of the cache parameter group does not allow the requested operation to occur.  
HTTP Status Code: 400

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_ModifyCacheParameterGroup_Examples"></a>

### ModifyCacheParameterGroup
<a name="API_ModifyCacheParameterGroup_Example_1"></a>

This example illustrates one usage of ModifyCacheParameterGroup.

#### Sample Request
<a name="API_ModifyCacheParameterGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=ModifyCacheParameterGroup
   &CacheParameterGroupName=mycacheparametergroup
   &ParameterNameValues.ParameterNameValue.1.ParameterName=chunk_size_growth_factor
   &ParameterNameValues.ParameterNameValue.1.ParameterValue=1.02
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_ModifyCacheParameterGroup_Example_1_Response"></a>

```
<ModifyCacheParameterGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <ModifyCacheParameterGroupResult>
    <CacheParameterGroupName>mycacheparametergroup</CacheParameterGroupName>
  </ModifyCacheParameterGroupResult>
  <ResponseMetadata>
    <RequestId>fcedeef2-b7ff-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</ModifyCacheParameterGroupResponse>
```

## See Also
<a name="API_ModifyCacheParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyCacheParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyCacheParameterGroup) 

# ModifyCacheSubnetGroup
<a name="API_ModifyCacheSubnetGroup"></a>

Modifies an existing cache subnet group.

## Request Parameters
<a name="API_ModifyCacheSubnetGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSubnetGroupName **   
The name for the cache subnet group. This value is stored as a lowercase string.  
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.  
Example: `mysubnetgroup`   
Type: String  
Required: Yes

 ** CacheSubnetGroupDescription **   
A description of the cache subnet group.  
Type: String  
Required: No

 **SubnetIds.SubnetIdentifier.N**   
The EC2 subnet IDs for the cache subnet group.  
Type: Array of strings  
Required: No

## Response Elements
<a name="API_ModifyCacheSubnetGroup_ResponseElements"></a>

The following element is returned by the service.

 ** CacheSubnetGroup **   
Represents the output of one of the following operations:  
+  `CreateCacheSubnetGroup` 
+  `ModifyCacheSubnetGroup` 
Type: [CacheSubnetGroup](API_CacheSubnetGroup.md) object

## Errors
<a name="API_ModifyCacheSubnetGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

 ** CacheSubnetQuotaExceededFault **   
The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.  
HTTP Status Code: 400

 ** InvalidSubnet **   
An invalid subnet identifier was specified.  
HTTP Status Code: 400

 ** SubnetInUse **   
The requested subnet is being used by another cache subnet group.  
HTTP Status Code: 400

 ** SubnetNotAllowedFault **   
At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyCacheSubnetGroup_Examples"></a>

### ModifyCacheSubnetGroup
<a name="API_ModifyCacheSubnetGroup_Example_1"></a>

This example illustrates one usage of ModifyCacheSubnetGroup.

#### Sample Request
<a name="API_ModifyCacheSubnetGroup_Example_1_Request"></a>

```
https://elasticache.amazonaws.com/
   ?Action=ModifyCacheSubnetGroup
   &CacheSubnetGroupName=myCachesubnetgroup
   &CacheSubnetGroupDescription=My%20modified%20CacheSubnetGroup
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_ModifyCacheSubnetGroup_Example_1_Response"></a>

```
<ModifyCacheSubnetGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
    <ModifyCacheSubnetGroupResult>
            <CacheSubnetGroup>
                <VpcId>990524496922</VpcId>
                <CacheSubnetGroupDescription>My modified CacheSubnetGroup</CacheSubnetGroupDescription>
                <CacheSubnetGroupName>myCachesubnetgroup</CacheSubnetGroupName>
                <Subnets>
                    <Subnet>
                        <SubnetStatus>Active</SubnetStatus>
                        <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>
                        <SubnetAvailabilityZone>
                            <Name>us-west-2c</Name>
                        </SubnetAvailabilityZone>
                    </Subnet>
                    <Subnet>
                        <SubnetStatus>Active</SubnetStatus>
                        <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>
                        <SubnetAvailabilityZone>
                            <Name>us-west-2b</Name>
                        </SubnetAvailabilityZone>
                    </Subnet>
                    <Subnet>
                        <SubnetStatus>Active</SubnetStatus>
                        <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>
                        <SubnetAvailabilityZone>
                            <Name>us-west-2c</Name>
                        </SubnetAvailabilityZone>
                    </Subnet>
                </Subnets>
            </CacheSubnetGroup>
        </ModifyCacheSubnetGroupResult>
        <ResponseMetadata>
            <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>
        </ResponseMetadata>
    </ModifyCacheSubnetGroupResponse>
```

## See Also
<a name="API_ModifyCacheSubnetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyCacheSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyCacheSubnetGroup) 

# ModifyGlobalReplicationGroup
<a name="API_ModifyGlobalReplicationGroup"></a>

Modifies the settings for a Global datastore.

## Request Parameters
<a name="API_ModifyGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyImmediately **   
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.   
Type: Boolean  
Required: Yes

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: Yes

 ** AutomaticFailoverEnabled **   
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.   
Type: Boolean  
Required: No

 ** CacheNodeType **   
A valid cache node type that you want to scale this Global datastore to.  
Type: String  
Required: No

 ** CacheParameterGroupName **   
The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.  
Type: String  
Required: No

 ** Engine **   
Modifies the engine listed in a global replication group message. The options are valkey, memcached or redis.  
Type: String  
Required: No

 ** EngineVersion **   
The upgraded version of the cache engine to be run on the clusters in the Global datastore.   
Type: String  
Required: No

 ** GlobalReplicationGroupDescription **   
A description of the Global datastore  
Type: String  
Required: No

## Response Elements
<a name="API_ModifyGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_ModifyGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_ModifyGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyGlobalReplicationGroup) 

# ModifyReplicationGroup
<a name="API_ModifyReplicationGroup"></a>

Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.
+  [Scaling for Valkey or Redis OSS (cluster mode enabled)](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/scaling-redis-cluster-mode-enabled.html) in the ElastiCache User Guide
+  [ModifyReplicationGroupShardConfiguration](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html) in the ElastiCache API Reference

**Note**  
This operation is valid for Valkey or Redis OSS only.

## Request Parameters
<a name="API_ModifyReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ReplicationGroupId **   
The identifier of the replication group to modify.  
Type: String  
Required: Yes

 ** ApplyImmediately **   
If `true`, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the replication group.  
If `false`, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.  
Valid values: `true` \$1 `false`   
Default: `false`   
Type: Boolean  
Required: No

 ** AuthToken **   
Reserved parameter. The password used to access a password protected server. This parameter must be specified with the `auth-token-update-strategy ` parameter. Password constraints:  
+ Must be only printable ASCII characters
+ Must be at least 16 characters and no more than 128 characters in length
+ Cannot contain any of the following characters: '/', '"', or '@', '%'
 For more information, see AUTH password at [AUTH](http://redis.io/commands/AUTH).  
Type: String  
Required: No

 ** AuthTokenUpdateStrategy **   
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the `auth-token` parameter. Possible values:  
+ ROTATE - default, if no update strategy is provided
+ SET - allowed only after ROTATE
+ DELETE - allowed only when transitioning to RBAC
 For more information, see [Authenticating Users with AUTH](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth.html)   
Type: String  
Valid Values: `SET | ROTATE | DELETE`   
Required: No

 ** AutomaticFailoverEnabled **   
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.  
Valid values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** AutoMinorVersionUpgrade **   
 If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.    
Type: Boolean  
Required: No

 ** CacheNodeType **   
A valid cache node type that you want to scale this replication group to.  
Type: String  
Required: No

 ** CacheParameterGroupName **   
The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the `ApplyImmediately` parameter is specified as `true` for this request.  
Type: String  
Required: No

 **CacheSecurityGroupNames.CacheSecurityGroupName.N**   
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.  
This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).  
Constraints: Must contain no more than 255 alphanumeric characters. Must not be `Default`.  
Type: Array of strings  
Required: No

 ** ClusterMode **   
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.  
Type: String  
Valid Values: `enabled | disabled | compatible`   
Required: No

 ** Engine **   
Modifies the engine listed in a replication group message. The options are valkey, memcached or redis.  
Type: String  
Required: No

 ** EngineVersion **   
The upgraded version of the cache engine to be run on the clusters in the replication group.  
 **Important:** You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement)), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.   
Type: String  
Required: No

 ** IpDiscovery **   
The network type you choose when modifying a cluster, either `ipv4` \$1 `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/).  
Type: String  
Valid Values: `ipv4 | ipv6`   
Required: No

 **LogDeliveryConfigurations.LogDeliveryConfigurationRequest.N**   
Specifies the destination, format and type of the logs.  
Type: Array of [LogDeliveryConfigurationRequest](API_LogDeliveryConfigurationRequest.md) objects  
Required: No

 ** MultiAZEnabled **   
A flag to indicate MultiAZ is enabled.  
Type: Boolean  
Required: No

 ** NodeGroupId **   
Deprecated. This parameter is not used.  
Type: String  
Required: No

 ** NotificationTopicArn **   
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.  
The Amazon SNS topic owner must be same as the replication group owner. 
Type: String  
Required: No

 ** NotificationTopicStatus **   
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is `active`.  
Valid values: `active` \$1 `inactive`   
Type: String  
Required: No

 ** PreferredMaintenanceWindow **   
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.  
Valid values for `ddd` are:  
+  `sun` 
+  `mon` 
+  `tue` 
+  `wed` 
+  `thu` 
+  `fri` 
+  `sat` 
Example: `sun:23:00-mon:01:30`   
Type: String  
Required: No

 ** PrimaryClusterId **   
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.  
Type: String  
Required: No

 ** RemoveUserGroups **   
Removes the user group associated with this replication group.  
Type: Boolean  
Required: No

 ** ReplicationGroupDescription **   
A description for the replication group. Maximum length is 255 characters.  
Type: String  
Required: No

 **SecurityGroupIds.SecurityGroupId.N**   
Specifies the VPC Security Groups associated with the clusters in the replication group.  
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).  
Type: Array of strings  
Required: No

 ** SnapshotRetentionLimit **   
The number of days for which ElastiCache retains automatic node group (shard) 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.  
 **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.  
Type: Integer  
Required: No

 ** SnapshottingClusterId **   
The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.  
Type: String  
Required: No

 ** SnapshotWindow **   
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by `SnapshottingClusterId`.  
Example: `05:00-09:00`   
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.  
Type: String  
Required: No

 ** TransitEncryptionEnabled **   
A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set `TransitEncryptionMode` to `preferred`.  
Type: Boolean  
Required: No

 ** TransitEncryptionMode **   
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.  
You must set `TransitEncryptionEnabled` to `true`, for your existing cluster, and set `TransitEncryptionMode` to `preferred` in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set the value to `required` to allow encrypted connections only.  
Setting `TransitEncryptionMode` to `required` is a two-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`.   
Type: String  
Valid Values: `preferred | required`   
Required: No

 **UserGroupIdsToAdd.member.N**   
The ID of the user group you are associating with the replication group.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: No

 **UserGroupIdsToRemove.member.N**   
The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: No

## Response Elements
<a name="API_ModifyReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_ModifyReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** InsufficientCacheClusterCapacity **   
The requested cache node type is not available in the specified Availability Zone. For more information, see [InsufficientCacheClusterCapacity](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) in the ElastiCache User Guide.  
HTTP Status Code: 400

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidCacheSecurityGroupState **   
The current state of the cache security group does not allow deletion.  
HTTP Status Code: 400

 ** InvalidKMSKeyFault **   
The KMS key supplied is not valid.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidUserGroupState **   
The user group is not in an active state.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The VPC network is in an invalid state.  
HTTP Status Code: 400

 ** NodeQuotaForClusterExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.  
HTTP Status Code: 400

 ** NodeQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

## Examples
<a name="API_ModifyReplicationGroup_Examples"></a>

### ModifyReplicationGroup
<a name="API_ModifyReplicationGroup_Example_1"></a>

This example illustrates one usage of ModifyReplicationGroup.

#### Sample Request
<a name="API_ModifyReplicationGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=ModifyReplicationGroup
   &ApplyImmediately=false
   &ReplicationGroupId=my-repgroup
   &PrimaryClusterId=my-replica-1
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_ModifyReplicationGroup_Example_1_Response"></a>

```
<ModifyReplicationGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <ModifyReplicationGroupResult> 
      <ReplicationGroup> 
         <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> 
         <MemberClusters> 
            <ClusterId>my-redis-primary</ClusterId> 
            <ClusterId>my-replica-1</ClusterId> 
         </MemberClusters> 
         <NodeGroups> 
            <NodeGroup> 
               <NodeGroupId>0001</NodeGroupId> 
               <PrimaryEndpoint> 
                  <Port>6379</Port> 
                  <Address>my-repgroup.q68zge.ng.0001.use1devo.elmo-dev.amazonaws.com</Address> 
               </PrimaryEndpoint> 
               <Status>available</Status> 
               <NodeGroupMembers> 
                  <NodeGroupMember> 
                     <CacheClusterId>my-redis-primary</CacheClusterId> 
                     <ReadEndpoint> 
                        <Port>6379</Port> 
                        <Address>my-redis-primary.q68zge.0001.use1devo.elmo-dev.amazonaws.com</Address> 
                     </ReadEndpoint> 
                     <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone> 
                     <CacheNodeId>0001</CacheNodeId> 
                     <CurrentRole>primary</CurrentRole> 
                  </NodeGroupMember> 
                  <NodeGroupMember> 
                     <CacheClusterId>my-replica-1</CacheClusterId> 
                     <ReadEndpoint> 
                        <Port>6379</Port> 
                        <Address>my-replica-1.q68zge.0001.use1devo.elmo-dev.amazonaws.com</Address> 
                     </ReadEndpoint> 
                     <PreferredAvailabilityZone>us-west-2b</PreferredAvailabilityZone> 
                     <CacheNodeId>0001</CacheNodeId> 
                     <CurrentRole>replica</CurrentRole> 
                  </NodeGroupMember> 
               </NodeGroupMembers> 
            </NodeGroup> 
         </NodeGroups> 
         <ReplicationGroupId>my-repgroup</ReplicationGroupId> 
         <Status>available</Status> 
         <PendingModifiedValues> 
            <PrimaryClusterId>my-replica-1</PrimaryClusterId> 
         </PendingModifiedValues> 
         <Description>My replication group</Description> 
      </ReplicationGroup> 
   </ModifyReplicationGroupResult> 
   <ResponseMetadata> 
      <RequestId>6fd0aad6-b9d7-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</ModifyReplicationGroupResponse>
```

## See Also
<a name="API_ModifyReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyReplicationGroup) 

# ModifyReplicationGroupShardConfiguration
<a name="API_ModifyReplicationGroupShardConfiguration"></a>

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

## Request Parameters
<a name="API_ModifyReplicationGroupShardConfiguration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyImmediately **   
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is `true`.  
Value: true  
Type: Boolean  
Required: Yes

 ** NodeGroupCount **   
The number of node groups (shards) that results from the modification of the shard configuration.  
Type: Integer  
Required: Yes

 ** ReplicationGroupId **   
The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.  
Type: String  
Required: Yes

 **NodeGroupsToRemove.NodeGroupToRemove.N**   
If the value of `NodeGroupCount` is less than the current number of node groups (shards), then either `NodeGroupsToRemove` or `NodeGroupsToRetain` is required. `NodeGroupsToRemove` is a list of `NodeGroupId`s to remove from the cluster.  
ElastiCache will attempt to remove all node groups listed by `NodeGroupsToRemove` from the cluster.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `\d+`   
Required: No

 **NodeGroupsToRetain.NodeGroupToRetain.N**   
If the value of `NodeGroupCount` is less than the current number of node groups (shards), then either `NodeGroupsToRemove` or `NodeGroupsToRetain` is required. `NodeGroupsToRetain` is a list of `NodeGroupId`s to retain in the cluster.  
ElastiCache will attempt to remove all node groups except those listed by `NodeGroupsToRetain` from the cluster.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `\d+`   
Required: No

 **ReshardingConfiguration.ReshardingConfiguration.N**   
Specifies the preferred availability zones for each node group in the cluster. If the value of `NodeGroupCount` is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.  
You can specify this parameter only if the value of `NodeGroupCount` is greater than the current number of node groups (shards).  
Type: Array of [ReshardingConfiguration](API_ReshardingConfiguration.md) objects  
Required: No

## Response Elements
<a name="API_ModifyReplicationGroupShardConfiguration_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_ModifyReplicationGroupShardConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCacheClusterCapacity **   
The requested cache node type is not available in the specified Availability Zone. For more information, see [InsufficientCacheClusterCapacity](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) in the ElastiCache User Guide.  
HTTP Status Code: 400

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidKMSKeyFault **   
The KMS key supplied is not valid.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidVPCNetworkStateFault **   
The VPC network is in an invalid state.  
HTTP Status Code: 400

 ** NodeGroupsPerReplicationGroupQuotaExceeded **   
The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90  
HTTP Status Code: 400

 ** NodeQuotaForCustomerExceeded **   
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

## Examples
<a name="API_ModifyReplicationGroupShardConfiguration_Examples"></a>

### Add shards
<a name="API_ModifyReplicationGroupShardConfiguration_Example_1"></a>

The following example adds shards to the replication group `my-cluster` so that at the completion of the call there are 4 shards. The availability zones for the nodes in the shards are specified by the parameter `ReshardingConfiguration.ReshardingConfiguration.N.PreferredAvailabilityZones.AvailabilityZone.N`. If there are already 4 shards in this replication group, the call fails.

```
https://elasticache.us-east-2.amazonaws.com/
    ?Action=ModifyReplicationGroupShardConfiguration
    &ApplyImmediately=true
    &NodeGroupCount=4
    &ReplicationGroupId=my-cluster
    &ReshardingConfiguration.ReshardingConfiguration.1.PreferredAvailabilityZones.AvailabilityZone.1=us-east-2a 
    &ReshardingConfiguration.ReshardingConfiguration.1.PreferredAvailabilityZones.AvailabilityZone.2=us-east-2c 
    &ReshardingConfiguration.ReshardingConfiguration.2.PreferredAvailabilityZones.AvailabilityZone.1=us-east-2b 
    &ReshardingConfiguration.ReshardingConfiguration.2.PreferredAvailabilityZones.AvailabilityZone.2=us-east-2a 
    &ReshardingConfiguration.ReshardingConfiguration.3.PreferredAvailabilityZones.AvailabilityZone.1=us-east-2c 
    &ReshardingConfiguration.ReshardingConfiguration.3.PreferredAvailabilityZones.AvailabilityZone.2=us-east-2d 
    &ReshardingConfiguration.ReshardingConfiguration.4.PreferredAvailabilityZones.AvailabilityZone.1=us-east-2d 
    &ReshardingConfiguration.ReshardingConfiguration.4.PreferredAvailabilityZones.AvailabilityZone.2=us-east-2c 
    &Version=2015-02-02
    &SignatureVersion=4
    &SignatureMethod=HmacSHA256
    &Timestamp=20171002T192317Z
    &X-Amz-Credential=<credential>
```

### Remove shards
<a name="API_ModifyReplicationGroupShardConfiguration_Example_2"></a>

The following example removes two shards from the replication group `my-cluster`. leaving 2 shards. When removing shards, the parameter `NodeGroupsToRemove.NodeGroupToRemove` is required.

You cannot remove the last shard leaving zero shards.

```
https://elasticache.us-east-2.amazonaws.com/
    ?Action=ModifyReplicationGroupShardConfiguration
    &ApplyImmediately=true
    &NodeGroupCount=2
    &ReplicationGroupId=my-cluster
    &NodeGroupsToRemove.NodeGroupToRemove.1=0002
    &NodeGroupsToRemove.NodeGroupToRemove.2=0003
    &Version=2015-02-02
    &SignatureVersion=4
    &SignatureMethod=HmacSHA256
    &Timestamp=20171002T192317Z
    &X-Amz-Credential=<credential>
```

### Rebalance shards
<a name="API_ModifyReplicationGroupShardConfiguration_Example_3"></a>

The following rebalances the keyspaces among the existing shards in the replication group `my-cluster`. The value specified by `NodeGroupCount` must be the existing number of shards. If the keyspaces are already balanced the call fails.

```
https://elasticache.us-east-2.amazonaws.com/
    ?Action=ModifyReplicationGroupShardConfiguration
    &ApplyImmediately=true
    &NodeGroupCount=4
    &ReplicationGroupId=my-cluster
    &Version=2015-02-02
    &SignatureVersion=4
    &SignatureMethod=HmacSHA256
    &Timestamp=20171002T192317Z
    &X-Amz-Credential=<credential>
```

## See Also
<a name="API_ModifyReplicationGroupShardConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration) 

# ModifyServerlessCache
<a name="API_ModifyServerlessCache"></a>

This API modifies the attributes of a serverless cache.

## Request Parameters
<a name="API_ModifyServerlessCache_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ServerlessCacheName **   
User-provided identifier for the serverless cache to be modified.  
Type: String  
Required: Yes

 ** CacheUsageLimits **   
Modify the cache usage limit for the serverless cache.  
Type: [CacheUsageLimits](API_CacheUsageLimits.md) object  
Required: No

 ** DailySnapshotTime **   
The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.  
Type: String  
Required: No

 ** Description **   
User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.  
Type: String  
Required: No

 ** Engine **   
Modifies the engine listed in a serverless cache request. The options are valkey, memcached or redis.  
Type: String  
Required: No

 ** MajorEngineVersion **   
Modifies the engine vesion listed in a serverless cache request.   
Type: String  
Required: No

 ** RemoveUserGroup **   
The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.  
Type: Boolean  
Required: No

 **SecurityGroupIds.SecurityGroupId.N**   
The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.  
Type: Array of strings  
Required: No

 ** SnapshotRetentionLimit **   
The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.  
Type: Integer  
Required: No

 ** UserGroupId **   
The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL - the existing UserGroup is not removed.  
Type: String  
Required: No

## Response Elements
<a name="API_ModifyServerlessCache_ResponseElements"></a>

The following element is returned by the service.

 ** ServerlessCache **   
The response for the attempt to modify the serverless cache.  
Type: [ServerlessCache](API_ServerlessCache.md) object

## Errors
<a name="API_ModifyServerlessCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidCredentials **   
You must enter valid credentials.  
HTTP Status Code: 408

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidServerlessCacheStateFault **   
The account for these credentials is not currently active.  
HTTP Status Code: 400

 ** InvalidUserGroupState **   
The user group is not in an active state.  
HTTP Status Code: 400

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

## Examples
<a name="API_ModifyServerlessCache_Examples"></a>

### ModifyServerlessCache
<a name="API_ModifyServerlessCache_Example_1"></a>

This example illustrates one usage of ModifyServerlessCache.

#### Sample Request
<a name="API_ModifyServerlessCache_Example_1_Request"></a>

```
{
    "description": "Modify the daily snapshot time of cache",
    "input": {
        "ServerlessCacheName": "my-serverless-cache",
        "CacheUsageLimits": {
            "DataStorage" : {
                "Maximum" : 10, 
                "Unit" : "GB"
            }, 
            "ECPUPerSecond" : {
                "Maximum" : 50000
            }
        },
        "DailySnapshotTime": "11:00"
    },
    "output": {
        "ServerlessCache": {
            "ServerlessCacheName": "my-serverless-cache",
            "Description": "A serverless cache.",
            "Status": "available",
            "Engine": "redis",
            "MajorEngineVersion": "7",
            "FullEngineVersion": "7.0",
            "SubnetIds": [
                "subnet-xxx8c982",
                "subnet-xxx382f3",
                "subnet-xxxb3e7c0"
            ],
            "CacheUsageLimits": {
                "DataStorage" : {
                    "Maximum" : 10, 
                    "Unit" : "GB"
                }, 
                "ECPUPerSecond" : {
                    "Maximum" : 50000
                }
            },
            "SecurityGroupIds": [
                "sg-xxx0c9af"
            ],
            "Endpoint": {
                "Address": "my-serverless-cache-xxxxxx.serverless.use1qa.cache.amazonaws.com",
                "Port": 6379
            },
            "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
            "SnapshotRetentionLimit": 10,
            "DailySnapshotTime": "11:00",
            "NetworkType": "ipv4"
        }
    }
}
```

## See Also
<a name="API_ModifyServerlessCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyServerlessCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyServerlessCache) 

# ModifyUser
<a name="API_ModifyUser"></a>

Changes user password(s) and/or access string.

## Request Parameters
<a name="API_ModifyUser_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** UserId **   
The ID of the user.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: Yes

 ** AccessString **   
Access permissions string used for this user.  
Type: String  
Pattern: `.*\S.*`   
Required: No

 ** AppendAccessString **   
Adds additional user permissions to the access string.  
Type: String  
Pattern: `.*\S.*`   
Required: No

 ** AuthenticationMode **   
Specifies how to authenticate the user.  
Type: [AuthenticationMode](API_AuthenticationMode.md) object  
Required: No

 ** Engine **   
Modifies the engine listed for a user. The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*`   
Required: No

 ** NoPasswordRequired **   
Indicates no password is required for the user.  
Type: Boolean  
Required: No

 **Passwords.member.N**   
The passwords belonging to the user. You are allowed up to two.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Required: No

## Response Elements
<a name="API_ModifyUser_ResponseElements"></a>

The following elements are returned by the service.

 ** AccessString **   
Access permissions string used for this user.  
Type: String

 ** ARN **   
The Amazon Resource Name (ARN) of the user.  
Type: String

 ** Authentication **   
Denotes whether the user requires a password to authenticate.  
Type: [Authentication](API_Authentication.md) object

 ** Engine **   
The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*` 

 ** MinimumEngineVersion **   
The minimum engine version required, which is Redis OSS 6.0  
Type: String

 ** Status **   
Indicates the user status. Can be "active", "modifying" or "deleting".  
Type: String

 **UserGroupIds.member.N**   
Returns a list of the user group IDs the user belongs to.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` 

 ** UserId **   
The ID of the user.  
Type: String

 ** UserName **   
The username of the user.  
Type: String

## Errors
<a name="API_ModifyUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidUserState **   
The user is not in active state.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## See Also
<a name="API_ModifyUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyUser) 

# ModifyUserGroup
<a name="API_ModifyUserGroup"></a>

Changes the list of users that belong to the user group.

## Request Parameters
<a name="API_ModifyUserGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** UserGroupId **   
The ID of the user group.  
Type: String  
Required: Yes

 ** Engine **   
Modifies the engine listed in a user group. The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*`   
Required: No

 **UserIdsToAdd.member.N**   
The list of user IDs to add to the user group.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: No

 **UserIdsToRemove.member.N**   
The list of user IDs to remove from the user group.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*`   
Required: No

## Response Elements
<a name="API_ModifyUserGroup_ResponseElements"></a>

The following elements are returned by the service.

 ** ARN **   
The Amazon Resource Name (ARN) of the user group.  
Type: String

 ** Engine **   
The options are valkey or redis.  
Type: String  
Pattern: `[a-zA-Z]*` 

 ** MinimumEngineVersion **   
The minimum engine version required, which is Redis OSS 6.0  
Type: String

 ** PendingChanges **   
A list of updates being applied to the user group.  
Type: [UserGroupPendingChanges](API_UserGroupPendingChanges.md) object

 **ReplicationGroups.member.N**   
A list of replication groups that the user group can access.  
Type: Array of strings

 **ServerlessCaches.member.N**   
Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.  
Type: Array of strings

 ** Status **   
Indicates user group status. Can be "creating", "active", "modifying", "deleting".  
Type: String

 ** UserGroupId **   
The ID of the user group.  
Type: String

 **UserIds.member.N**   
The list of user IDs that belong to the user group.  
Type: Array of strings  
Length Constraints: Minimum length of 1.  
Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` 

## Errors
<a name="API_ModifyUserGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DefaultUserRequired **   
You must add default user to a user group.  
HTTP Status Code: 400

 ** DuplicateUserName **   
A user with this username already exists.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidUserGroupState **   
The user group is not in an active state.  
HTTP Status Code: 400

 ** ServiceLinkedRoleNotFoundFault **   
The specified service linked role (SLR) was not found.  
HTTP Status Code: 400

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## See Also
<a name="API_ModifyUserGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ModifyUserGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ModifyUserGroup) 

# PurchaseReservedCacheNodesOffering
<a name="API_PurchaseReservedCacheNodesOffering"></a>

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see [Managing Costs with Reserved Nodes](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/reserved-nodes.html).

## Request Parameters
<a name="API_PurchaseReservedCacheNodesOffering_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ReservedCacheNodesOfferingId **   
The ID of the reserved cache node offering to purchase.  
Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706`   
Type: String  
Required: Yes

 ** CacheNodeCount **   
The number of cache node instances to reserve.  
Default: `1`   
Type: Integer  
Required: No

 ** ReservedCacheNodeId **   
A customer-specified identifier to track this reservation.  
The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
Example: myreservationID  
Type: String  
Required: No

 **Tags.Tag.N**   
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_PurchaseReservedCacheNodesOffering_ResponseElements"></a>

The following element is returned by the service.

 ** ReservedCacheNode **   
Represents the output of a `PurchaseReservedCacheNodesOffering` operation.  
Type: [ReservedCacheNode](API_ReservedCacheNode.md) object

## Errors
<a name="API_PurchaseReservedCacheNodesOffering_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** ReservedCacheNodeAlreadyExists **   
You already have a reservation with the given identifier.  
HTTP Status Code: 404

 ** ReservedCacheNodeQuotaExceeded **   
The request cannot be processed because it would exceed the user's cache node quota.  
HTTP Status Code: 400

 ** ReservedCacheNodesOfferingNotFound **   
The requested cache node offering does not exist.  
HTTP Status Code: 404

 ** TagQuotaPerResourceExceeded **   
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.  
HTTP Status Code: 400

## Examples
<a name="API_PurchaseReservedCacheNodesOffering_Examples"></a>

### PurchaseReservedCacheNodesOffering
<a name="API_PurchaseReservedCacheNodesOffering_Example_1"></a>

This example illustrates one usage of PurchaseReservedCacheNodesOffering.

#### Sample Request
<a name="API_PurchaseReservedCacheNodesOffering_Example_1_Request"></a>

```
https://elasticache.amazonaws.com/
   ?Action=PurchaseReservedCacheNodesOffering
   &ReservedCacheNodeId=myreservationID
   &ReservedCacheNodesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706
   &CacheNodeCount=1
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_PurchaseReservedCacheNodesOffering_Example_1_Response"></a>

```
<PurchaseReservedCacheNodesOfferingResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <PurchaseReservedCacheNodesOfferingResult>
    <ReservedCacheNode>
      <OfferingType>Medium Utilization</OfferingType>
      <RecurringCharges/>
      <ProductDescription>memcached</ProductDescription>
      <ReservedCacheNodesOfferingId> 438012d3-4052-4cc7-b2e3-8d3372e0e706</ReservedCacheNodesOfferingId>
      <State>payment-pending</State>
      <ReservedCacheNodeId>myreservationID</ReservedCacheNodeId>
      <CacheNodeCount>10</CacheNodeCount>
      <StartTime>2015-02-02T23:24:56.577Z</StartTime>
      <Duration>31536000</Duration>
      <FixedPrice>123.0</FixedPrice>
      <UsagePrice>0.123</UsagePrice>
      <CacheNodeType>cache.m1.small</CacheNodeType>
    </ReservedCacheNode>
  </PurchaseReservedCacheNodesOfferingResult>
  <ResponseMetadata>
    <RequestId>7f099901-29cf-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</PurchaseReservedCacheNodesOfferingResponse>
```

## See Also
<a name="API_PurchaseReservedCacheNodesOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering) 

# RebalanceSlotsInGlobalReplicationGroup
<a name="API_RebalanceSlotsInGlobalReplicationGroup"></a>

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

## Request Parameters
<a name="API_RebalanceSlotsInGlobalReplicationGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ApplyImmediately **   
If `True`, redistribution is applied immediately.  
Type: Boolean  
Required: Yes

 ** GlobalReplicationGroupId **   
The name of the Global datastore  
Type: String  
Required: Yes

## Response Elements
<a name="API_RebalanceSlotsInGlobalReplicationGroup_ResponseElements"></a>

The following element is returned by the service.

 ** GlobalReplicationGroup **   
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.  
+ The **GlobalReplicationGroupIdSuffix** represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: [GlobalReplicationGroup](API_GlobalReplicationGroup.md) object

## Errors
<a name="API_RebalanceSlotsInGlobalReplicationGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GlobalReplicationGroupNotFoundFault **   
The Global datastore does not exist  
HTTP Status Code: 404

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## See Also
<a name="API_RebalanceSlotsInGlobalReplicationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/RebalanceSlotsInGlobalReplicationGroup) 

# RebootCacheCluster
<a name="API_RebootCacheCluster"></a>

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters.

If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see [Rebooting a Cluster](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/nodes.rebooting.html) for an alternate process.

## Request Parameters
<a name="API_RebootCacheCluster_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheClusterId **   
The cluster identifier. This parameter is stored as a lowercase string.  
Type: String  
Required: Yes

 **CacheNodeIdsToReboot.CacheNodeId.N**   
A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.  
Type: Array of strings  
Required: Yes

## Response Elements
<a name="API_RebootCacheCluster_ResponseElements"></a>

The following element is returned by the service.

 ** CacheCluster **   
Contains all of the attributes of a specific cluster.  
Type: [CacheCluster](API_CacheCluster.md) object

## Errors
<a name="API_RebootCacheCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

## Examples
<a name="API_RebootCacheCluster_Examples"></a>

### RebootCacheCluster
<a name="API_RebootCacheCluster_Example_1"></a>

This example illustrates one usage of RebootCacheCluster.

#### Sample Request
<a name="API_RebootCacheCluster_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=RebootCacheCluster
   &CacheClusterId=mycache
   &CacheNodeIdsToReboot.CacheNodeId.1=0001
   &CacheNodeIdsToReboot.CacheNodeId.2=0002
   &CacheNodeIdsToReboot.CacheNodeId.3=0003
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_RebootCacheCluster_Example_1_Response"></a>

```
<RebootCacheClusterResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <RebootCacheClusterResult> 
      <CacheCluster> 
         <CacheClusterStatus>rebooting cluster nodes</CacheClusterStatus> 
         <CacheParameterGroup> 
            <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName> 
            <ParameterApplyStatus>in-sync</ParameterApplyStatus> 
            <CacheNodeIdsToReboot /> 
         </CacheParameterGroup> 
         <CacheClusterId>mycache</CacheClusterId> 
         <ConfigurationEndpoint> 
            <Port>11211</Port> 
            <Address>mycache.q68zge.cfg.use1devo.elmo-dev.amazonaws.com</Address> 
         </ConfigurationEndpoint> 
         <CacheNodeType>cache.m1.small</CacheNodeType> 
         <Engine>memcached</Engine> 
         <PendingModifiedValues /> 
         <PreferredAvailabilityZone>us-west-2b</PreferredAvailabilityZone> 
         <CacheClusterCreateTime>2015-02-02T19:04:12.812Z</CacheClusterCreateTime> 
         <EngineVersion>1.4.17</EngineVersion> 
         <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
         <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> 
         <ClientDownloadLandingPage>https://console.aws.amazon.com/elasticache/home#client-download:</ClientDownloadLandingPage> 
         <CacheSecurityGroups> 
            <CacheSecurityGroup> 
               <CacheSecurityGroupName>default</CacheSecurityGroupName> 
               <Status>active</Status> 
            </CacheSecurityGroup> 
         </CacheSecurityGroups> 
         <NumCacheNodes>3</NumCacheNodes> 
      </CacheCluster> 
   </RebootCacheClusterResult> 
   <ResponseMetadata> 
      <RequestId>cf7e6fc4-b9d1-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</RebootCacheClusterResponse>
```

## See Also
<a name="API_RebootCacheCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/RebootCacheCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/RebootCacheCluster) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Removes the tags identified by the `TagKeys` list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see [Resource-level permissions](http://docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html).

## Request Parameters
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceName **   
The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`.  
For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).  
Type: String  
Required: Yes

 **TagKeys.member.N**   
A list of `TagKeys` identifying the tags you want removed from the named resource.  
Type: Array of strings  
Required: Yes

## Response Elements
<a name="API_RemoveTagsFromResource_ResponseElements"></a>

The following element is returned by the service.

 **TagList.Tag.N**   
A list of tags as key-value pairs.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_RemoveTagsFromResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheClusterNotFound **   
The requested cluster ID does not refer to an existing cluster.  
HTTP Status Code: 404

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** CacheSubnetGroupNotFoundFault **   
The requested cache subnet group name does not refer to an existing cache subnet group.  
HTTP Status Code: 400

 ** InvalidARN **   
The requested Amazon Resource Name (ARN) does not refer to an existing resource.  
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidServerlessCacheSnapshotStateFault **   
The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 400

 ** InvalidServerlessCacheStateFault **   
The account for these credentials is not currently active.  
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** ReservedCacheNodeNotFound **   
The requested reserved cache node was not found.  
HTTP Status Code: 404

 ** ServerlessCacheNotFoundFault **   
The serverless cache was not found or does not exist.  
HTTP Status Code: 404

 ** ServerlessCacheSnapshotNotFoundFault **   
This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.  
HTTP Status Code: 404

 ** SnapshotNotFoundFault **   
The requested snapshot name does not refer to an existing snapshot.  
HTTP Status Code: 404

 ** TagNotFound **   
The requested tag was not found on this resource.  
HTTP Status Code: 404

 ** UserGroupNotFound **   
The user group was not found or does not exist  
HTTP Status Code: 404

 ** UserNotFound **   
The user does not exist or could not be found.  
HTTP Status Code: 404

## Examples
<a name="API_RemoveTagsFromResource_Examples"></a>

### RemoveTagsFromResource
<a name="API_RemoveTagsFromResource_Example_1"></a>

This example illustrates one usage of RemoveTagsFromResource.

#### Sample Request
<a name="API_RemoveTagsFromResource_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=RemoveTagsFromResource
   &ResourceName=arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &TagKeys.TagKey.1=service
   &TagKeys.TagKey.2=organization
   &Version=2015-02-02
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/RemoveTagsFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/RemoveTagsFromResource) 

# ResetCacheParameterGroup
<a name="API_ResetCacheParameterGroup"></a>

Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the `ResetAllParameters` and `CacheParameterGroupName` parameters.

## Request Parameters
<a name="API_ResetCacheParameterGroup_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheParameterGroupName **   
The name of the cache parameter group to reset.  
Type: String  
Required: Yes

 **ParameterNameValues.ParameterNameValue.N**   
An array of parameter names to reset to their default values. If `ResetAllParameters` is `true`, do not use `ParameterNameValues`. If `ResetAllParameters` is `false`, you must specify the name of at least one parameter to reset.  
Type: Array of [ParameterNameValue](API_ParameterNameValue.md) objects  
Required: No

 ** ResetAllParameters **   
If `true`, all parameters in the cache parameter group are reset to their default values. If `false`, only the parameters listed by `ParameterNameValues` are reset to their default values.  
Valid values: `true` \$1 `false`   
Type: Boolean  
Required: No

## Response Elements
<a name="API_ResetCacheParameterGroup_ResponseElements"></a>

The following element is returned by the service.

 ** CacheParameterGroupName **   
The name of the cache parameter group.  
Type: String

## Errors
<a name="API_ResetCacheParameterGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CacheParameterGroupNotFound **   
The requested cache parameter group name does not refer to an existing cache parameter group.  
HTTP Status Code: 404

 ** InvalidCacheParameterGroupState **   
The current state of the cache parameter group does not allow the requested operation to occur.  
HTTP Status Code: 400

 ** InvalidGlobalReplicationGroupState **   
The Global datastore is not available or in primary-only state.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_ResetCacheParameterGroup_Examples"></a>

### ResetCacheParameterGroup
<a name="API_ResetCacheParameterGroup_Example_1"></a>

This example illustrates one usage of ResetCacheParameterGroup.

#### Sample Request
<a name="API_ResetCacheParameterGroup_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=ResetCacheParameterGroup
   &ResetAllParameters=true
   &CacheParameterGroupName=mycacheparametergroup1
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_ResetCacheParameterGroup_Example_1_Response"></a>

```
<ResetCacheParameterGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <ResetCacheParameterGroupResult> 
      <CacheParameterGroupName>mycacheparametergroup1</CacheParameterGroupName> 
   </ResetCacheParameterGroupResult> 
   <ResponseMetadata> 
      <RequestId>cb7cc855-b9d2-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</ResetCacheParameterGroupResponse>
```

## See Also
<a name="API_ResetCacheParameterGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/ResetCacheParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/ResetCacheParameterGroup) 

# RevokeCacheSecurityGroupIngress
<a name="API_RevokeCacheSecurityGroupIngress"></a>

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

## Request Parameters
<a name="API_RevokeCacheSecurityGroupIngress_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CacheSecurityGroupName **   
The name of the cache security group to revoke ingress from.  
Type: String  
Required: Yes

 ** EC2SecurityGroupName **   
The name of the Amazon EC2 security group to revoke access from.  
Type: String  
Required: Yes

 ** EC2SecurityGroupOwnerId **   
The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.  
Type: String  
Required: Yes

## Response Elements
<a name="API_RevokeCacheSecurityGroupIngress_ResponseElements"></a>

The following element is returned by the service.

 ** CacheSecurityGroup **   
Represents the output of one of the following operations:  
+  `AuthorizeCacheSecurityGroupIngress` 
+  `CreateCacheSecurityGroup` 
+  `RevokeCacheSecurityGroupIngress` 
Type: [CacheSecurityGroup](API_CacheSecurityGroup.md) object

## Errors
<a name="API_RevokeCacheSecurityGroupIngress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationNotFound **   
The specified Amazon EC2 security group is not authorized for the specified cache security group.  
HTTP Status Code: 404

 ** CacheSecurityGroupNotFound **   
The requested cache security group name does not refer to an existing cache security group.  
HTTP Status Code: 404

 ** InvalidCacheSecurityGroupState **   
The current state of the cache security group does not allow deletion.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

## Examples
<a name="API_RevokeCacheSecurityGroupIngress_Examples"></a>

### RevokeCacheSecurityGroupIngress
<a name="API_RevokeCacheSecurityGroupIngress_Example_1"></a>

This example illustrates one usage of RevokeCacheSecurityGroupIngress.

#### Sample Request
<a name="API_RevokeCacheSecurityGroupIngress_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=RevokeCacheSecurityGroupIngress
   &EC2SecurityGroupName=default
   &CacheSecurityGroupName=mygroup
   &EC2SecurityGroupOwnerId=1234-5678-1234
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>
```

#### Sample Response
<a name="API_RevokeCacheSecurityGroupIngress_Example_1_Response"></a>

```
<RevokeCacheSecurityGroupIngressResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
    <RevokeCacheSecurityGroupIngressResult>
        <CacheSecurityGroup>
            <EC2SecurityGroups>
                <EC2SecurityGroup>
                    <Status>revoking</Status>
                    <EC2SecurityGroupName>default</EC2SecurityGroupName>
                    <EC2SecurityGroupOwnerId>123456781234</EC2SecurityGroupOwnerId>
                </EC2SecurityGroup>
            </EC2SecurityGroups>
            <CacheSecurityGroupName>mygroup</CacheSecurityGroupName>
            <OwnerId>123456789012</OwnerId>
            <Description>My security group</Description>
        </CacheSecurityGroup>
    </RevokeCacheSecurityGroupIngressResult>
    <ResponseMetadata>
        <RequestId>02ae3699-3650-11e0-a564-8f11342c56b0</RequestId>
    </ResponseMetadata>
</RevokeCacheSecurityGroupIngressResponse>
```

## See Also
<a name="API_RevokeCacheSecurityGroupIngress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress) 

# StartMigration
<a name="API_StartMigration"></a>

Start the migration of data.

## Request Parameters
<a name="API_StartMigration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **CustomerNodeEndpointList.member.N**   
List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element.  
Type: Array of [CustomerNodeEndpoint](API_CustomerNodeEndpoint.md) objects  
Required: Yes

 ** ReplicationGroupId **   
The ID of the replication group to which data should be migrated.  
Type: String  
Required: Yes

## Response Elements
<a name="API_StartMigration_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_StartMigration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** ReplicationGroupAlreadyUnderMigrationFault **   
The targeted replication group is not available.   
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

## See Also
<a name="API_StartMigration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/StartMigration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/StartMigration) 

# TestFailover
<a name="API_TestFailover"></a>

Represents the input of a `TestFailover` operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

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. 

**Note the following**
+ A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
+ If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

   
+ If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
+ 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:

  1. Replication group message: `Test Failover API called for node group <node-group-id>` 

  1. Cache cluster message: `Failover from primary node <primary-node-id> to replica node <node-id> completed` 

  1. Replication group message: `Failover from primary node <primary-node-id> to replica node <node-id> completed` 

  1. Cache cluster message: `Recovering cache nodes <node-id>` 

  1. Cache cluster message: `Finished recovery for cache nodes <node-id>` 

  For more information see:
  +  [Viewing ElastiCache Events](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/ECEvents.Viewing.html) in the *ElastiCache User Guide* 
  +  [DescribeEvents](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html) in the ElastiCache API Reference

Also see, [Testing Multi-AZ ](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/AutoFailover.html#auto-failover-test) in the *ElastiCache User Guide*.

## Request Parameters
<a name="API_TestFailover_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NodeGroupId **   
The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 15 node groups in any rolling 24-hour period.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `\d+`   
Required: Yes

 ** ReplicationGroupId **   
The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.  
Type: String  
Required: Yes

## Response Elements
<a name="API_TestFailover_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_TestFailover_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** APICallRateForCustomerExceeded **   
The customer has exceeded the allowed rate of API calls.  
HTTP Status Code: 400

 ** InvalidCacheClusterState **   
The requested cluster is not in the `available` state.  
HTTP Status Code: 400

 ** InvalidKMSKeyFault **   
The KMS key supplied is not valid.  
HTTP Status Code: 400

 ** InvalidParameterCombination **   
Two or more incompatible parameters were specified.    
 ** message **   
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** NodeGroupNotFoundFault **   
The node group specified by the `NodeGroupId` parameter could not be found. Please verify that the node group exists and that you spelled the `NodeGroupId` value correctly.  
HTTP Status Code: 404

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

 ** TestFailoverNotAvailableFault **   
The `TestFailover` action is not available.  
HTTP Status Code: 400

## Examples
<a name="API_TestFailover_Examples"></a>

### Example
<a name="API_TestFailover_Example_1"></a>

The following example tests automatic failover on the Valkey or Redis OSS (cluster mode disabled) replication group (console: cluster) `redis00`. Since there is only one node group in Valkey or Redis OSS (cluster mode disabled) clusters, the *NodeGroupId* will always be `<cluster-name>-0001`.

#### Sample Request
<a name="API_TestFailover_Example_1_Request"></a>

```
https://elasticache.us-west-2.amazonaws.com/
   ?Action=TestFailover
   &NodeGroupId=redis00-0001
   &ReplicationGroupId=redis00
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20170418T192317Z
   &X-Amz-Credential=<credential>
```

## See Also
<a name="API_TestFailover_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/TestFailover) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/TestFailover) 

# TestMigration
<a name="API_TestMigration"></a>

 Async API to test connection between source and target replication group. 

## Request Parameters
<a name="API_TestMigration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **CustomerNodeEndpointList.member.N**   
 List of endpoints from which data should be migrated. List should have only one element.   
Type: Array of [CustomerNodeEndpoint](API_CustomerNodeEndpoint.md) objects  
Required: Yes

 ** ReplicationGroupId **   
 The ID of the replication group to which data is to be migrated.   
Type: String  
Required: Yes

## Response Elements
<a name="API_TestMigration_ResponseElements"></a>

The following element is returned by the service.

 ** ReplicationGroup **   
Contains all of the attributes of a specific Valkey or Redis OSS replication group.  
Type: [ReplicationGroup](API_ReplicationGroup.md) object

## Errors
<a name="API_TestMigration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValue **   
The value for a parameter is invalid.    
 ** message **   
A parameter value is invalid.
HTTP Status Code: 400

 ** InvalidReplicationGroupState **   
The requested replication group is not in the `available` state.  
HTTP Status Code: 400

 ** ReplicationGroupAlreadyUnderMigrationFault **   
The targeted replication group is not available.   
HTTP Status Code: 400

 ** ReplicationGroupNotFoundFault **   
The specified replication group does not exist.  
HTTP Status Code: 404

## See Also
<a name="API_TestMigration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticache-2015-02-02/TestMigration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticache-2015-02-02/TestMigration)