AWS ElastiCache (version v1.*.*)

add_tags_to_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. For example, you can use cost-allocation tags to your ElastiCache resources, AWS 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 in the ElastiCache User Guide.

Parameters

$body

Represents the input of an AddTagsToResource operation.

Type: object

{
  "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. \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ]
}

authorize_cache_security_group_ingress

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.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

Parameters

$body

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

Type: object

{
  "EC2SecurityGroupName" : "The Amazon EC2 security group to be authorized for ingress to the cache security group.",
  "EC2SecurityGroupOwnerId" : "The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.",
  "CacheSecurityGroupName" : "The cache security group that allows network ingress."
}

batch_apply_update_action

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

Parameters

$body

Type: object

{
  "CacheClusterIds" : [ "string" ],
  "ReplicationGroupIds" : [ "string" ],
  "ServiceUpdateName" : "The unique ID of the service update"
}

batch_stop_update_action

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

Parameters

$body

Type: object

{
  "CacheClusterIds" : [ "string" ],
  "ReplicationGroupIds" : [ "string" ],
  "ServiceUpdateName" : "The unique ID of the service update"
}

complete_migration

Complete the migration of data.

Parameters

$body

Type: object

{
  "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.",
  "ReplicationGroupId" : "The ID of the replication group to which data is being migrated."
}

copy_snapshot

Makes a copy of an existing snapshot.
This operation is valid for Redis only.
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 and Authentication & Access Control.
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 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 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 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 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 in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP 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 in the ElastiCache User Guide.

Parameters

$body

Represents the input of a CopySnapshotMessage operation.

Type: object

{
  "KmsKeyId" : "The ID of the KMS key used to encrypt the target snapshot.",
  "SourceSnapshotName" : "The name of an existing snapshot from which to make a copy.",
  "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.",
  "TargetBucket" : "The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. \nWhen 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 in the Amazon ElastiCache User Guide. \nFor more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ]
}

create_cache_cluster

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters.

Parameters

$body

Represents the input of a CreateCacheCluster operation.

Type: object

{
  "CacheSecurityGroupNames" : [ {
    "CacheSecurityGroupName" : "string"
  } ],
  "CacheClusterId" : "The node group (shard) identifier. This parameter is stored as a lowercase string. \n Constraints:   \n A name must contain from 1 to 50 alphanumeric characters or hyphens.  \n The first character must be a letter.  \n A name cannot end with a hyphen or contain two consecutive hyphens. ",
  "SnapshotArns" : [ {
    "SnapshotArn" : "string"
  } ],
  "Port" : "The port number on which each of the cache nodes accepts connections.",
  "PreferredOutpostArn" : "The outpost ARN in which the cache cluster is created.",
  "NumCacheNodes" : "The initial number of cache nodes that the cluster has. \nFor clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40. \nIf 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/.",
  "SnapshotName" : "The name of a Redis 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.  \nThis parameter is only valid if the Engine parameter is redis.",
  "NotificationTopicArn" : "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.  \nThe Amazon SNS topic owner must be the same as the cluster owner.",
  "OutpostMode" : "Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.",
  "PreferredAvailabilityZones" : [ {
    "PreferredAvailabilityZone" : "string"
  } ],
  "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. \nIf 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.  \nThis parameter is only valid if the Engine parameter is redis.",
  "Engine" : "The name of the cache engine to be used for this cluster. \nValid values for this parameter are: memcached | redis ",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ],
  "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. \n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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. ",
  "PreferredOutpostArns" : [ {
    "PreferredOutpostArn" : "string"
  } ],
  "CacheSubnetGroupName" : "The name of the subnet group to be used for the cluster. \nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).  \nIf 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.",
  "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.",
  "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:",
  "AutoMinorVersionUpgrade" : "This parameter is currently disabled.",
  "PreferredAvailabilityZone" : "The EC2 Availability Zone in which the cluster is created. \nAll 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. \nDefault: System chosen Availability Zone.",
  "SecurityGroupIds" : [ {
    "SecurityGroupId" : "string"
  } ],
  "SnapshotWindow" : "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). \nExample: 05:00-09:00  \nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.  \nThis parameter is only valid if the Engine parameter is redis.",
  "CacheNodeType" : "The compute and memory capacity of the nodes in the node group (shard). \nThe 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.  \n General purpose:   Current generation:   M6g node types (available only for Redis 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   For region availability, see Supported Node Types    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   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)  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     \n Compute optimized:   Previous generation: (not recommended)  C1 node types: cache.c1.xlarge     \n Memory optimized:   Current generation:   R6g node types (available only for Redis 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   For region availability, see Supported Node Types    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)  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      \n Additional node type info   \n All current generation instance types are created in Amazon VPC by default.  \n Redis append-only files (AOF) are not supported for T1 or T2 instances.  \n Redis Multi-AZ with automatic failover is not supported on T1 instances.  \n Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later. ",
  "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.  \nThis parameter is only valid if the Engine parameter is redis.  \nDefault: 0 (i.e., automatic backups are disabled for this cache cluster).",
  "AuthToken" : " Reserved parameter. The password used to access a password protected server. \nPassword constraints:  \n Must be only printable ASCII characters.  \n Must be at least 16 characters and no more than 128 characters in length.  \n The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.   \nFor more information, see AUTH password at http://redis.io/commands/AUTH.",
  "LogDeliveryConfigurations" : [ {
    "LogDeliveryConfigurationRequest" : {
      "LogFormat" : "Specifies either JSON or TEXT",
      "LogType" : "Refers to slow-log.",
      "Enabled" : "Specify if log delivery is enabled. Default true.",
      "DestinationType" : "Specify either cloudwatch-logs or kinesis-firehose as the destination type.",
      "DestinationDetails" : {
        "CloudWatchLogsDetails" : {
          "LogGroup" : "The name of the CloudWatch Logs log group."
        },
        "KinesisFirehoseDetails" : {
          "DeliveryStream" : "The name of the Kinesis Data Firehose delivery stream."
        }
      }
    }
  } ],
  "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. \nThis parameter is only supported for Memcached clusters. \nIf the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode."
}

create_cache_parameter_group

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 in the ElastiCache API Reference.
Parameters and Parameter Groups in the ElastiCache User Guide.

Parameters

$body

Represents the input of a CreateCacheParameterGroup operation.

Type: object

{
  "Description" : "A user-specified description for the cache parameter group.",
  "CacheParameterGroupName" : "A user-specified name for the cache parameter group.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ],
  "CacheParameterGroupFamily" : "The name of the cache parameter group family that the cache parameter group can be used with. \nValid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | "
}

create_cache_security_group

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.

Parameters

$body

Represents the input of a CreateCacheSecurityGroup operation.

Type: object

{
  "Description" : "A description for the cache security group.",
  "CacheSecurityGroupName" : "A name for the cache security group. This value is stored as a lowercase string. \nConstraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\". \nExample: mysecuritygroup ",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ]
}

create_cache_subnet_group

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

Parameters

$body

Represents the input of a CreateCacheSubnetGroup operation.

Type: object

{
  "CacheSubnetGroupName" : "A name for the cache subnet group. This value is stored as a lowercase string. \nConstraints: Must contain no more than 255 alphanumeric characters or hyphens. \nExample: mysubnetgroup ",
  "SubnetIds" : [ {
    "SubnetIdentifier" : "string"
  } ],
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ],
  "CacheSubnetGroupDescription" : "A description for the cache subnet group."
}

create_global_replication_group

Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
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.

Parameters

$body

Type: object

{
  "GlobalReplicationGroupIdSuffix" : "The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each AWS 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.  \nFor a full list of AWS Regions and their respective Global datastore iD prefixes, see Using the AWS CLI with Global datastores .",
  "GlobalReplicationGroupDescription" : "Provides details of the Global datastore",
  "PrimaryReplicationGroupId" : "The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster."
}

create_replication_group

Creates a Redis (cluster mode disabled) or a Redis (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 Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis 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 Redis 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. For versions below 5.0.6, the limit is 250 per cluster. To request a limit increase, see AWS Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis (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 avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
This operation is valid for Redis only.

Parameters

$body

Represents the input of a CreateReplicationGroup operation.

Type: object

{
  "PreferredCacheClusterAZs" : [ {
    "AvailabilityZone" : "string"
  } ],
  "CacheSecurityGroupNames" : [ {
    "CacheSecurityGroupName" : "string"
  } ],
  "NodeGroupConfiguration" : [ {
    "NodeGroupConfiguration" : {
      "Slots" : "A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey. \nExample: \"0-3999\" ",
      "ReplicaAvailabilityZones" : [ {
        "AvailabilityZone" : "string"
      } ],
      "NodeGroupId" : "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.",
      "ReplicaCount" : "The number of read replica nodes in this node group (shard).",
      "PrimaryAvailabilityZone" : "The Availability Zone where the primary node of this node group (shard) is launched.",
      "PrimaryOutpostArn" : "The outpost ARN of the primary node.",
      "ReplicaOutpostArns" : [ {
        "OutpostArn" : "string"
      } ]
    }
  } ],
  "SnapshotArns" : [ {
    "SnapshotArn" : "string"
  } ],
  "Port" : "The port number on which each member of the replication group accepts connections.",
  "NumNodeGroups" : "An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. \nDefault: 1",
  "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.",
  "NotificationTopicArn" : "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.  \nThe Amazon SNS topic owner must be the same as the cluster owner.",
  "ReplicationGroupDescription" : "A user-created description for the replication group.",
  "AutomaticFailoverEnabled" : "Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. \n AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. \nDefault: false",
  "ReplicasPerNodeGroup" : "An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.",
  "MultiAZEnabled" : "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.",
  "TransitEncryptionEnabled" : "A flag that enables in-transit encryption when set to true. \nYou cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. \nThis 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. \nIf you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. \n Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. \nDefault: false   \nFor HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.",
  "ReplicationGroupId" : "The replication group identifier. This parameter is stored as a lowercase string. \nConstraints:  \n A name must contain from 1 to 40 alphanumeric characters or hyphens.  \n The first character must be a letter.  \n A name cannot end with a hyphen or contain two consecutive hyphens. ",
  "Engine" : "The name of the cache engine to be used for the clusters in this replication group. Must be Redis.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ],
  "NumCacheClusters" : "The number of clusters this replication group initially has. \nThis parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead. \nIf 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. \nThe maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).",
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "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. \n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) 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. ",
  "KmsKeyId" : "The ID of the KMS key used to encrypt the disk in the cluster.",
  "CacheSubnetGroupName" : "The name of the cache subnet group to be used for the replication group.  \nIf 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.",
  "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. \nThis parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.",
  "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. \nIf you are running Redis 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.   \n To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.  \n To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on. ",
  "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: \nSpecifies 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. \nValid values for ddd are:  \n  sun   \n  mon   \n  tue   \n  wed   \n  thu   \n  fri   \n  sat    \nExample: sun:23:00-mon:01:30 ",
  "AtRestEncryptionEnabled" : "A flag that enables encryption at rest when set to true. \nYou 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.  \n Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. \nDefault: false ",
  "AutoMinorVersionUpgrade" : "This parameter is currently disabled.",
  "SecurityGroupIds" : [ {
    "SecurityGroupId" : "string"
  } ],
  "SnapshotWindow" : "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). \nExample: 05:00-09:00  \nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.",
  "CacheNodeType" : "The compute and memory capacity of the nodes in the node group (shard). \nThe 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.  \n General purpose:   Current generation:   M6g node types (available only for Redis 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   For region availability, see Supported Node Types    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   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)  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     \n Compute optimized:   Previous generation: (not recommended)  C1 node types: cache.c1.xlarge     \n Memory optimized:   Current generation:   R6g node types (available only for Redis 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   For region availability, see Supported Node Types    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)  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      \n Additional node type info   \n All current generation instance types are created in Amazon VPC by default.  \n Redis append-only files (AOF) are not supported for T1 or T2 instances.  \n Redis Multi-AZ with automatic failover is not supported on T1 instances.  \n Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later. ",
  "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. \nDefault: 0 (i.e., automatic backups are disabled for this cluster).",
  "UserGroupIds" : [ "string" ],
  "AuthToken" : " Reserved parameter. The password used to access a password protected server. \n AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.  \nFor HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.  \nPassword constraints:  \n Must be only printable ASCII characters.  \n Must be at least 16 characters and no more than 128 characters in length.  \n The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.   \nFor more information, see AUTH password at http://redis.io/commands/AUTH.",
  "LogDeliveryConfigurations" : [ {
    "LogDeliveryConfigurationRequest" : {
      "LogFormat" : "Specifies either JSON or TEXT",
      "LogType" : "Refers to slow-log.",
      "Enabled" : "Specify if log delivery is enabled. Default true.",
      "DestinationType" : "Specify either cloudwatch-logs or kinesis-firehose as the destination type.",
      "DestinationDetails" : {
        "CloudWatchLogsDetails" : {
          "LogGroup" : "The name of the CloudWatch Logs log group."
        },
        "KinesisFirehoseDetails" : {
          "DeliveryStream" : "The name of the Kinesis Data Firehose delivery stream."
        }
      }
    }
  } ]
}

create_snapshot

Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.

Parameters

$body

Represents the input of a CreateSnapshot operation.

Type: object

{
  "CacheClusterId" : "The identifier of an existing cluster. The snapshot is created from this cluster.",
  "KmsKeyId" : "The ID of the KMS key used to encrypt the snapshot.",
  "ReplicationGroupId" : "The identifier of an existing replication group. The snapshot is created from this replication group.",
  "SnapshotName" : "A name for the snapshot being created.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ]
}

create_user

For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

Parameters

$body

Type: object

{
  "UserName" : "The username of the user.",
  "NoPasswordRequired" : "Indicates a password is not required for this user.",
  "AccessString" : "Access permissions string used for this user.",
  "UserId" : "The ID of the user.",
  "Passwords" : [ "string" ],
  "Engine" : "The current supported value is Redis. ",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ]
}

create_user_group

For Redis engine version 6.x onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)

Parameters

$body

Type: object

{
  "UserGroupId" : "The ID of the user group.",
  "Engine" : "The current supported value is Redis. ",
  "UserIds" : [ "string" ],
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ]
}

decrease_node_groups_in_global_replication_group

Decreases the number of node groups in a Global datastore

Parameters

$body

Type: object

{
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "GlobalNodeGroupsToRemove" : [ {
    "GlobalNodeGroupId" : "string"
  } ],
  "GlobalNodeGroupsToRetain" : [ {
    "GlobalNodeGroupId" : "string"
  } ],
  "NodeGroupCount" : "The number of node groups (shards) that results from the modification of the shard configuration",
  "ApplyImmediately" : "Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. "
}

decrease_replica_count

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

Parameters

$body

Type: object

{
  "NewReplicaCount" : "The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups. \nThe minimum number of replicas in a shard or replication group is:  \n Redis (cluster mode disabled)   If Multi-AZ is enabled: 1   If Multi-AZ is not enabled: 0    \n Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails) ",
  "ReplicasToRemove" : [ "string" ],
  "ReplicationGroupId" : "The id of the replication group from which you want to remove replica nodes.",
  "ReplicaConfiguration" : [ {
    "ConfigureShard" : {
      "NewReplicaCount" : "The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with. \nThe minimum number of replicas in a shard or replication group is:  \n Redis (cluster mode disabled)   If Multi-AZ: 1   If Multi-AZ: 0    \n Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails) ",
      "PreferredOutpostArns" : [ {
        "PreferredOutpostArn" : "string"
      } ],
      "NodeGroupId" : "The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.",
      "PreferredAvailabilityZones" : [ {
        "PreferredAvailabilityZone" : "string"
      } ]
    }
  } ],
  "ApplyImmediately" : "If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported."
}

delete_cache_cluster

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:
Redis (cluster mode enabled) clusters
Redis (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 Redis (cluster mode enabled) replication group
A cluster that is not in the available state

Parameters

$body

Represents the input of a DeleteCacheCluster operation.

Type: object

{
  "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.",
  "CacheClusterId" : "The cluster identifier for the cluster to be deleted. This parameter is not case sensitive."
}

delete_cache_parameter_group

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.

Parameters

$body

Represents the input of a DeleteCacheParameterGroup operation.

Type: object

{
  "CacheParameterGroupName" : "The name of the cache parameter group to delete.  \nThe specified cache security group must not be associated with any clusters."
}

delete_cache_security_group

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

Parameters

$body

Represents the input of a DeleteCacheSecurityGroup operation.

Type: object

{
  "CacheSecurityGroupName" : "The name of the cache security group to delete.  \nYou cannot delete the default security group."
}

delete_cache_subnet_group

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

Parameters

$body

Represents the input of a DeleteCacheSubnetGroup operation.

Type: object

{
  "CacheSubnetGroupName" : "The name of the cache subnet group to delete. \nConstraints: Must contain no more than 255 alphanumeric characters or hyphens."
}

delete_global_replication_group

Deleting a Global datastore is a two-step process:
First, you must DisassociateGlobalReplicationGroup 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.

Parameters

$body

Type: object

{
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "RetainPrimaryReplicationGroup" : "The primary replication group is retained as a standalone replication group. "
}

delete_replication_group

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.
This operation is valid for Redis only.

Parameters

$body

Represents the input of a DeleteReplicationGroup operation.

Type: object

{
  "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.",
  "ReplicationGroupId" : "The identifier for the cluster to be deleted. This parameter is not case sensitive.",
  "RetainPrimaryCluster" : "If set to true, all of the read replicas are deleted, but the primary node is retained."
}

delete_snapshot

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.
This operation is valid for Redis only.

Parameters

$body

Represents the input of a DeleteSnapshot operation.

Type: object

{
  "SnapshotName" : "The name of the snapshot to be deleted."
}

delete_user

For Redis engine version 6.x 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).

Parameters

$body

Type: object

{
  "UserId" : "The ID of the user."
}

delete_user_group

For Redis engine version 6.x 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).

Parameters

$body

Type: object

{
  "UserGroupId" : "The ID of the user group."
}

describe_cache_clusters

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.

Parameters

$body

Represents the input of a DescribeCacheClusters operation.

Type: object

{
  "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.",
  "ShowCacheNodeInfo" : "An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.",
  "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 mean Memcached and single node Redis clusters."
}

describe_cache_engine_versions

Returns a list of the available cache engines and their versions.

Parameters

$body

Represents the input of a DescribeCacheEngineVersions operation.

Type: object

{
  "DefaultOnly" : "If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.",
  "EngineVersion" : "The cache engine version to return. \nExample: 1.4.14 ",
  "Engine" : "The cache engine to return. Valid values: memcached | redis ",
  "CacheParameterGroupFamily" : "The name of a specific cache parameter group family to return details for. \nValid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |  \nConstraints:  \n Must be 1 to 255 alphanumeric characters  \n First character must be a letter  \n Cannot end with a hyphen or contain two consecutive hyphens "
}

describe_cache_parameter_groups

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.

Parameters

$body

Represents the input of a DescribeCacheParameterGroups operation.

Type: object

{
  "CacheParameterGroupName" : "The name of a specific cache parameter group to return details for."
}

describe_cache_parameters

Returns the detailed parameter list for a particular cache parameter group.

Parameters

$body

Represents the input of a DescribeCacheParameters operation.

Type: object

{
  "CacheParameterGroupName" : "The name of a specific cache parameter group to return details for.",
  "Source" : "The parameter types to return. \nValid values: user | system | engine-default "
}

describe_cache_security_groups

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

Parameters

$body

Represents the input of a DescribeCacheSecurityGroups operation.

Type: object

{
  "CacheSecurityGroupName" : "The name of the cache security group to return details for."
}

describe_cache_subnet_groups

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.

Parameters

$body

Represents the input of a DescribeCacheSubnetGroups operation.

Type: object

{
  "CacheSubnetGroupName" : "The name of the cache subnet group to return details for."
}

describe_engine_default_parameters

Returns the default engine and system parameter information for the specified cache engine.

Parameters

$body

Represents the input of a DescribeEngineDefaultParameters operation.

Type: object

{
  "CacheParameterGroupFamily" : "The name of the cache parameter group family. \nValid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | "
}

describe_events

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.

Parameters

$body

Represents the input of a DescribeEvents operation.

Type: object

{
  "EndTime" : "The end of the time interval for which to retrieve events, specified in ISO 8601 format. \n Example: 2017-03-30T07:03:49.555Z",
  "SourceType" : "The event source to retrieve events for. If no value is specified, all events are returned.",
  "SourceIdentifier" : "The identifier of the event source for which events are returned. If not specified, all sources are included in the response.",
  "StartTime" : "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. \n Example: 2017-03-30T07:03:49.555Z",
  "Duration" : "The number of minutes worth of events to retrieve."
}

describe_global_replication_groups

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

Parameters

$body

Type: object

{
  "ShowMemberInfo" : "Returns the list of members that comprise the Global datastore.",
  "GlobalReplicationGroupId" : "The name of the Global datastore"
}

describe_replication_groups

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
This operation is valid for Redis only.

Parameters

$body

Represents the input of a DescribeReplicationGroups operation.

Type: object

{
  "ReplicationGroupId" : "The identifier for the replication group to be described. This parameter is not case sensitive. \nIf you do not specify this parameter, information about all replication groups is returned."
}

describe_reserved_cache_nodes

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

Parameters

$body

Represents the input of a DescribeReservedCacheNodes operation.

Type: object

{
  "OfferingType" : "The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. \nValid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\" ",
  "CacheNodeType" : "The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type. \nThe 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.  \n General purpose:   Current generation:   M6g node types (available only for Redis 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   For region availability, see Supported Node Types    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   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)  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     \n Compute optimized:   Previous generation: (not recommended)  C1 node types: cache.c1.xlarge     \n Memory optimized:   Current generation:   R6g node types (available only for Redis 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   For region availability, see Supported Node Types    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)  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      \n Additional node type info   \n All current generation instance types are created in Amazon VPC by default.  \n Redis append-only files (AOF) are not supported for T1 or T2 instances.  \n Redis Multi-AZ with automatic failover is not supported on T1 instances.  \n Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later. ",
  "ReservedCacheNodeId" : "The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.",
  "Duration" : "The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration. \nValid Values: 1 | 3 | 31536000 | 94608000 ",
  "ProductDescription" : "The product description filter value. Use this parameter to show only those reservations matching the specified product description.",
  "ReservedCacheNodesOfferingId" : "The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier."
}

describe_reserved_cache_nodes_offerings

Lists available reserved cache node offerings.

Parameters

$body

Represents the input of a DescribeReservedCacheNodesOfferings operation.

Type: object

{
  "OfferingType" : "The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. \nValid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\" ",
  "CacheNodeType" : "The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type. \nThe 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.  \n General purpose:   Current generation:   M6g node types (available only for Redis 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   For region availability, see Supported Node Types    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   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)  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     \n Compute optimized:   Previous generation: (not recommended)  C1 node types: cache.c1.xlarge     \n Memory optimized:   Current generation:   R6g node types (available only for Redis 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   For region availability, see Supported Node Types    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)  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      \n Additional node type info   \n All current generation instance types are created in Amazon VPC by default.  \n Redis append-only files (AOF) are not supported for T1 or T2 instances.  \n Redis Multi-AZ with automatic failover is not supported on T1 instances.  \n Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later. ",
  "Duration" : "Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration. \nValid Values: 1 | 3 | 31536000 | 94608000 ",
  "ProductDescription" : "The product description filter value. Use this parameter to show only the available offerings matching the specified product description.",
  "ReservedCacheNodesOfferingId" : "The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. \nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706 "
}

describe_service_updates

Returns details of the service updates

Parameters

$body

Type: object

{
  "ServiceUpdateStatus" : [ "string. Possible values: available | cancelled | expired" ],
  "ServiceUpdateName" : "The unique ID of the service update"
}

describe_snapshots

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.
This operation is valid for Redis only.

Parameters

$body

Represents the input of a DescribeSnapshotsMessage operation.

Type: object

{
  "CacheClusterId" : "A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.",
  "ShowNodeGroupConfig" : "A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.",
  "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.",
  "ReplicationGroupId" : "A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.",
  "SnapshotName" : "A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described."
}

describe_update_actions

Returns details of the update actions

Parameters

$body

Type: object

{
  "UpdateActionStatus" : [ "string. Possible values: not-applied | waiting-to-start | in-progress | stopping | stopped | complete | scheduling | scheduled | not-applicable" ],
  "ShowNodeLevelUpdateStatus" : "Dictates whether to include node level update status in the response ",
  "ServiceUpdateStatus" : [ "string. Possible values: available | cancelled | expired" ],
  "CacheClusterIds" : [ "string" ],
  "ReplicationGroupIds" : [ "string" ],
  "ServiceUpdateTimeRange" : {
    "EndTime" : "The end time of the time range filter",
    "StartTime" : "The start time of the time range filter"
  },
  "Engine" : "The Elasticache engine to which the update applies. Either Redis or Memcached ",
  "ServiceUpdateName" : "The unique ID of the service update"
}

describe_user_groups

Returns a list of user groups.

Parameters

$body

Type: object

{
  "UserGroupId" : "The ID of the user group."
}

describe_users

Returns a list of users.

Parameters

$body

Type: object

{
  "Filters" : [ {
    "Filter" : {
      "Values" : [ "string" ],
      "Name" : "The property being filtered. For example, UserId."
    }
  } ],
  "UserId" : "The ID of the user.",
  "Engine" : "The Redis engine. "
}

disassociate_global_replication_group

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 AWS region.

Parameters

$body

Type: object

{
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "ReplicationGroupRegion" : "The AWS region of secondary cluster you wish to remove from the Global datastore",
  "ReplicationGroupId" : "The name of the secondary cluster you wish to remove from the Global datastore"
}

failover_global_replication_group

Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary.

Parameters

$body

Type: object

{
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "PrimaryRegion" : "The AWS region of the primary cluster of the Global datastore",
  "PrimaryReplicationGroupId" : "The name of the primary replication group"
}

increase_node_groups_in_global_replication_group

Increase the number of node groups in the Global datastore

Parameters

$body

Type: object

{
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "RegionalConfigurations" : [ {
    "RegionalConfiguration" : {
      "ReplicationGroupRegion" : "The AWS region where the cluster is stored",
      "ReplicationGroupId" : "The name of the secondary cluster",
      "ReshardingConfiguration" : [ {
        "ReshardingConfiguration" : {
          "NodeGroupId" : "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.",
          "PreferredAvailabilityZones" : [ {
            "AvailabilityZone" : "string"
          } ]
        }
      } ]
    }
  } ],
  "NodeGroupCount" : "The number of node groups you wish to add",
  "ApplyImmediately" : "Indicates that the process begins immediately. At present, the only permitted value for this parameter is true."
}

increase_replica_count

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

Parameters

$body

Type: object

{
  "NewReplicaCount" : "The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.",
  "ReplicationGroupId" : "The id of the replication group to which you want to add replica nodes.",
  "ReplicaConfiguration" : [ {
    "ConfigureShard" : {
      "NewReplicaCount" : "The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with. \nThe minimum number of replicas in a shard or replication group is:  \n Redis (cluster mode disabled)   If Multi-AZ: 1   If Multi-AZ: 0    \n Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails) ",
      "PreferredOutpostArns" : [ {
        "PreferredOutpostArn" : "string"
      } ],
      "NodeGroupId" : "The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.",
      "PreferredAvailabilityZones" : [ {
        "PreferredAvailabilityZone" : "string"
      } ]
    }
  } ],
  "ApplyImmediately" : "If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported."
}

list_allowed_node_type_modifications

Lists all available node types that you can scale your Redis cluster's or 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.

Parameters

$body

The input parameters for the ListAllowedNodeTypeModifications operation.

Type: object

{
  "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.  \nYou must provide a value for either the CacheClusterId or the ReplicationGroupId.",
  "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.  \nYou must provide a value for either the CacheClusterId or the ReplicationGroupId."
}

list_tags_for_resource

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. If the cluster is not in the available state, ListTagsForResource returns an error.

Parameters

$body

The input parameters for the ListTagsForResource operation.

Type: object

{
  "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. \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces."
}

modify_cache_cluster

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.

Parameters

$body

Represents the input of a ModifyCacheCluster operation.

Type: object

{
  "CacheSecurityGroupNames" : [ {
    "CacheSecurityGroupName" : "string"
  } ],
  "EngineVersion" : "The upgraded version of the cache engine to be run on the cache nodes. \n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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. ",
  "CacheClusterId" : "The cluster identifier. This value is stored as a lowercase string.",
  "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. \nValid values for ddd are:  \n  sun   \n  mon   \n  tue   \n  wed   \n  thu   \n  fri   \n  sat    \nExample: sun:23:00-mon:01:30 ",
  "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.",
  "CacheNodeIdsToRemove" : [ {
    "CacheNodeId" : "string"
  } ],
  "AutoMinorVersionUpgrade" : "This parameter is currently disabled.",
  "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. \nIf you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. \nFor clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.  \nAdding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately). \nA 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.",
  "SecurityGroupIds" : [ {
    "SecurityGroupId" : "string"
  } ],
  "NotificationTopicArn" : "The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.  \nThe Amazon SNS topic owner must be same as the cluster owner.",
  "NewAvailabilityZones" : [ {
    "PreferredAvailabilityZone" : "string"
  } ],
  "SnapshotWindow" : "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. ",
  "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.  \nIf the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.",
  "CacheNodeType" : "A valid cache node type that you want to scale this cluster up to.",
  "AuthTokenUpdateStrategy" : "Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:  \n Rotate  \n Set   \n For more information, see Authenticating Users with Redis AUTH ",
  "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:  \n Must be only printable ASCII characters  \n Must be at least 16 characters and no more than 128 characters in length  \n Cannot contain any of the following characters: '/', '\"', or '@', '%'   \n For more information, see AUTH password at AUTH.",
  "LogDeliveryConfigurations" : [ {
    "LogDeliveryConfigurationRequest" : {
      "LogFormat" : "Specifies either JSON or TEXT",
      "LogType" : "Refers to slow-log.",
      "Enabled" : "Specify if log delivery is enabled. Default true.",
      "DestinationType" : "Specify either cloudwatch-logs or kinesis-firehose as the destination type.",
      "DestinationDetails" : {
        "CloudWatchLogsDetails" : {
          "LogGroup" : "The name of the CloudWatch Logs log group."
        },
        "KinesisFirehoseDetails" : {
          "DeliveryStream" : "The name of the Kinesis Data Firehose delivery stream."
        }
      }
    }
  } ],
  "NotificationTopicStatus" : "The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. \nValid values: active | inactive ",
  "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. \nIf false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.  \nIf you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.  \nValid values: true | false  \nDefault: false ",
  "AZMode" : "Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones. \nValid values: single-az | cross-az. \nThis option is only supported for Memcached clusters.  \nYou 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. \nOnly newly created nodes are located in different Availability Zones. "
}

modify_cache_parameter_group

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.

Parameters

$body

Represents the input of a ModifyCacheParameterGroup operation.

Type: object

{
  "ParameterNameValues" : [ {
    "ParameterNameValue" : {
      "ParameterValue" : "The value of the parameter.",
      "ParameterName" : "The name of the parameter."
    }
  } ],
  "CacheParameterGroupName" : "The name of the cache parameter group to modify."
}

modify_cache_subnet_group

Modifies an existing cache subnet group.

Parameters

$body

Represents the input of a ModifyCacheSubnetGroup operation.

Type: object

{
  "CacheSubnetGroupName" : "The name for the cache subnet group. This value is stored as a lowercase string. \nConstraints: Must contain no more than 255 alphanumeric characters or hyphens. \nExample: mysubnetgroup ",
  "SubnetIds" : [ {
    "SubnetIdentifier" : "string"
  } ],
  "CacheSubnetGroupDescription" : "A description of the cache subnet group."
}

modify_global_replication_group

Modifies the settings for a Global datastore.

Parameters

$body

Type: object

{
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "CacheNodeType" : "A valid cache node type that you want to scale this Global datastore to.",
  "EngineVersion" : "The upgraded version of the cache engine to be run on the clusters in the Global datastore. ",
  "GlobalReplicationGroupDescription" : "A description of the Global datastore",
  "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.",
  "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. ",
  "AutomaticFailoverEnabled" : "Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. "
}

modify_replication_group

Modifies the settings for a replication group.
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis only.

Parameters

$body

Represents the input of a ModifyReplicationGroups operation.

Type: object

{
  "CacheSecurityGroupNames" : [ {
    "CacheSecurityGroupName" : "string"
  } ],
  "RemoveUserGroups" : "Removes the user groups that can access this replication group.",
  "NotificationTopicArn" : "The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.  \nThe Amazon SNS topic owner must be same as the replication group owner. ",
  "ReplicationGroupDescription" : "A description for the replication group. Maximum length is 255 characters.",
  "AutomaticFailoverEnabled" : "Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. \nValid values: true | false ",
  "MultiAZEnabled" : "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.",
  "UserGroupIdsToAdd" : [ "string" ],
  "ReplicationGroupId" : "The identifier of the replication group to modify.",
  "NotificationTopicStatus" : "The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. \nValid values: active | inactive ",
  "EngineVersion" : "The upgraded version of the cache engine to be run on the clusters in the replication group. \n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), 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. ",
  "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.",
  "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. \nValid values for ddd are:  \n  sun   \n  mon   \n  tue   \n  wed   \n  thu   \n  fri   \n  sat    \nExample: sun:23:00-mon:01:30 ",
  "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.",
  "AutoMinorVersionUpgrade" : "This parameter is currently disabled.",
  "SecurityGroupIds" : [ {
    "SecurityGroupId" : "string"
  } ],
  "SnapshotWindow" : "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId. \nExample: 05:00-09:00  \nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.",
  "UserGroupIdsToRemove" : [ "string" ],
  "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. \n Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.",
  "CacheNodeType" : "A valid cache node type that you want to scale this replication group to.",
  "NodeGroupId" : "Deprecated. This parameter is not used.",
  "SnapshottingClusterId" : "The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.",
  "AuthTokenUpdateStrategy" : "Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:  \n Rotate  \n Set   \n For more information, see Authenticating Users with Redis AUTH ",
  "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:  \n Must be only printable ASCII characters  \n Must be at least 16 characters and no more than 128 characters in length  \n Cannot contain any of the following characters: '/', '\"', or '@', '%'   \n For more information, see AUTH password at AUTH.",
  "LogDeliveryConfigurations" : [ {
    "LogDeliveryConfigurationRequest" : {
      "LogFormat" : "Specifies either JSON or TEXT",
      "LogType" : "Refers to slow-log.",
      "Enabled" : "Specify if log delivery is enabled. Default true.",
      "DestinationType" : "Specify either cloudwatch-logs or kinesis-firehose as the destination type.",
      "DestinationDetails" : {
        "CloudWatchLogsDetails" : {
          "LogGroup" : "The name of the CloudWatch Logs log group."
        },
        "KinesisFirehoseDetails" : {
          "DeliveryStream" : "The name of the Kinesis Data Firehose delivery stream."
        }
      }
    }
  } ],
  "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. \nIf false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. \nValid values: true | false  \nDefault: false "
}

modify_replication_group_shard_configuration

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

Parameters

$body

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

Type: object

{
  "NodeGroupsToRetain" : [ {
    "NodeGroupToRetain" : "string"
  } ],
  "NodeGroupsToRemove" : [ {
    "NodeGroupToRemove" : "string"
  } ],
  "ReplicationGroupId" : "The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.",
  "NodeGroupCount" : "The number of node groups (shards) that results from the modification of the shard configuration.",
  "ReshardingConfiguration" : [ {
    "ReshardingConfiguration" : {
      "NodeGroupId" : "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.",
      "PreferredAvailabilityZones" : [ {
        "AvailabilityZone" : "string"
      } ]
    }
  } ],
  "ApplyImmediately" : "Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. \nValue: true"
}

modify_user

Changes user password(s) and/or access string.

Parameters

$body

Type: object

{
  "NoPasswordRequired" : "Indicates no password is required for the user.",
  "AccessString" : "Access permissions string used for this user.",
  "UserId" : "The ID of the user.",
  "AppendAccessString" : "Adds additional user permissions to the access string.",
  "Passwords" : [ "string" ]
}

modify_user_group

Changes the list of users that belong to the user group.

Parameters

$body

Type: object

{
  "UserGroupId" : "The ID of the user group.",
  "UserIdsToRemove" : [ "string" ],
  "UserIdsToAdd" : [ "string" ]
}

purchase_reserved_cache_nodes_offering

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 for Redis or Managing Costs with Reserved Nodes for Memcached.

Parameters

$body

Represents the input of a PurchaseReservedCacheNodesOffering operation.

Type: object

{
  "CacheNodeCount" : "The number of cache node instances to reserve. \nDefault: 1 ",
  "ReservedCacheNodeId" : "A customer-specified identifier to track this reservation.  \nThe 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.  \nExample: myreservationID",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The tag's value. May be null.",
      "Key" : "The key for the tag. May not be null."
    }
  } ],
  "ReservedCacheNodesOfferingId" : "The ID of the reserved cache node offering to purchase. \nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706 "
}

rebalance_slots_in_global_replication_group

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

Parameters

$body

Type: object

{
  "GlobalReplicationGroupId" : "The name of the Global datastore",
  "ApplyImmediately" : "If True, redistribution is applied immediately."
}

reboot_cache_cluster

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 and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

Parameters

$body

Represents the input of a RebootCacheCluster operation.

Type: object

{
  "CacheClusterId" : "The cluster identifier. This parameter is stored as a lowercase string.",
  "CacheNodeIdsToReboot" : [ {
    "CacheNodeId" : "string"
  } ]
}

remove_tags_from_resource

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.

Parameters

$body

Represents the input of a RemoveTagsFromResource operation.

Type: object

{
  "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. \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.",
  "TagKeys" : [ "string" ]
}

reset_cache_parameter_group

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.

Parameters

$body

Represents the input of a ResetCacheParameterGroup operation.

Type: object

{
  "ParameterNameValues" : [ {
    "ParameterNameValue" : {
      "ParameterValue" : "The value of the parameter.",
      "ParameterName" : "The name of the parameter."
    }
  } ],
  "CacheParameterGroupName" : "The name of the cache parameter group to reset.",
  "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. \nValid values: true | false "
}

revoke_cache_security_group_ingress

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

Parameters

$body

Represents the input of a RevokeCacheSecurityGroupIngress operation.

Type: object

{
  "EC2SecurityGroupName" : "The name of the Amazon EC2 security group to revoke access from.",
  "EC2SecurityGroupOwnerId" : "The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.",
  "CacheSecurityGroupName" : "The name of the cache security group to revoke ingress from."
}

start_migration

Start the migration of data.

Parameters

$body

Type: object

{
  "ReplicationGroupId" : "The ID of the replication group to which data should be migrated.",
  "CustomerNodeEndpointList" : [ {
    "CustomerNodeEndpoint" : {
      "Address" : "The address of the node endpoint",
      "Port" : "The port of the node endpoint"
    }
  } ]
}

test_failover

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS 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 Redis (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 AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.

Parameters

$body

Type: object

{
  "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 5 node groups in any rolling 24-hour period.",
  "ReplicationGroupId" : "The name of the replication group (console: cluster) whose automatic failover is being tested by this operation."
}