Network.AWS.ElastiCache

Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

See: AWS API Reference

Service Configuration

elastiCache :: Service

API version '2015-02-02' of the Amazon ElastiCache SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by ElastiCache.

CacheSubnetGroupAlreadyExistsFault

_CacheSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache subnet group name is already in use by an existing cache subnet group.

CacheSubnetGroupInUse

_CacheSubnetGroupInUse :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache subnet group is currently in use.

CacheSecurityGroupNotFoundFault

_CacheSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache security group name does not refer to an existing cache security group.

ReservedCacheNodeAlreadyExistsFault

_ReservedCacheNodeAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

You already have a reservation with the given identifier.

AuthorizationAlreadyExistsFault

_AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified Amazon EC2 security group is already authorized for the specified cache security group.

ReservedCacheNodeQuotaExceededFault

_ReservedCacheNodeQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the user's cache node quota.

CacheSubnetGroupQuotaExceededFault

_CacheSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

ReplicationGroupNotFoundFault

_ReplicationGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified replication group does not exist.

ReservedCacheNodesOfferingNotFoundFault

_ReservedCacheNodesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache node offering does not exist.

TagQuotaPerResourceExceeded

_TagQuotaPerResourceExceeded :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10.

InvalidSubnet

_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError

An invalid subnet identifier was specified.

SnapshotNotFoundFault

_SnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested snapshot name does not refer to an existing snapshot.

InsufficientCacheClusterCapacityFault

_InsufficientCacheClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache node type is not available in the specified Availability Zone.

InvalidSnapshotStateFault

_InvalidSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The current state of the snapshot does not allow the requested action to occur.

SnapshotAlreadyExistsFault

_SnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

You already have a snapshot with the given name.

TagNotFoundFault

_TagNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested tag was not found on this resource.

SnapshotQuotaExceededFault

_SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the maximum number of snapshots.

CacheParameterGroupAlreadyExistsFault

_CacheParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

A cache parameter group with the requested name already exists.

NodeQuotaForClusterExceededFault

_NodeQuotaForClusterExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

SnapshotFeatureNotSupportedFault

_SnapshotFeatureNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError

You attempted one of the following actions:

• Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
• Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

CacheSubnetGroupNotFoundFault

_CacheSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache subnet group name does not refer to an existing cache subnet group.

ReservedCacheNodeNotFoundFault

_ReservedCacheNodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested reserved cache node was not found.

InvalidParameterValueException

_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError

The value for a parameter is invalid.

InvalidVPCNetworkStateFault

_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The VPC network is in an invalid state.

CacheClusterNotFoundFault

_CacheClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache cluster ID does not refer to an existing cache cluster.

InvalidReplicationGroupStateFault

_InvalidReplicationGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested replication group is not in the available state.

ReplicationGroupAlreadyExistsFault

_ReplicationGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified replication group already exists.

SubnetInUse

_SubnetInUse :: AsError a => Getting (First ServiceError) a ServiceError

The requested subnet is being used by another cache subnet group.

CacheClusterAlreadyExistsFault

_CacheClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

You already have a cache cluster with the given identifier.

ClusterQuotaForCustomerExceededFault

_ClusterQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

AuthorizationNotFoundFault

_AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified Amazon EC2 security group is not authorized for the specified cache security group.

CacheSecurityGroupQuotaExceededFault

_CacheSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the allowed number of cache security groups.

InvalidCacheClusterStateFault

_InvalidCacheClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache cluster is not in the available state.

CacheParameterGroupQuotaExceededFault

_CacheParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the maximum number of cache security groups.

NodeQuotaForCustomerExceededFault

_NodeQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

CacheSubnetQuotaExceededFault

_CacheSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

CacheParameterGroupNotFoundFault

_CacheParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterCombinationException

_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError

Two or more incompatible parameters were specified.

InvalidARNFault

_InvalidARNFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

InvalidCacheParameterGroupStateFault

_InvalidCacheParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The current state of the cache parameter group does not allow the requested action to occur.

CacheSecurityGroupAlreadyExistsFault

_CacheSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

A cache security group with the specified name already exists.

InvalidCacheSecurityGroupStateFault

_InvalidCacheSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The current state of the cache security group does not allow deletion.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

CacheClusterAvailable

cacheClusterAvailable :: Wait DescribeCacheClusters

Polls DescribeCacheClusters every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

CacheClusterDeleted

cacheClusterDeleted :: Wait DescribeCacheClusters

Polls DescribeCacheClusters every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

ReplicationGroupDeleted

replicationGroupDeleted :: Wait DescribeReplicationGroups

Polls DescribeReplicationGroups every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

ReplicationGroupAvailable

replicationGroupAvailable :: Wait DescribeReplicationGroups

Polls DescribeReplicationGroups every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DeleteCacheSecurityGroup

module Network.AWS.ElastiCache.DeleteCacheSecurityGroup

CreateReplicationGroup

module Network.AWS.ElastiCache.CreateReplicationGroup

DeleteCacheCluster

module Network.AWS.ElastiCache.DeleteCacheCluster

RebootCacheCluster

module Network.AWS.ElastiCache.RebootCacheCluster

RevokeCacheSecurityGroupIngress

module Network.AWS.ElastiCache.RevokeCacheSecurityGroupIngress

DescribeEvents (Paginated)

module Network.AWS.ElastiCache.DescribeEvents

DescribeEngineDefaultParameters (Paginated)

module Network.AWS.ElastiCache.DescribeEngineDefaultParameters

ModifyCacheParameterGroup

module Network.AWS.ElastiCache.ModifyCacheParameterGroup

CreateCacheCluster

module Network.AWS.ElastiCache.CreateCacheCluster

ListTagsForResource

module Network.AWS.ElastiCache.ListTagsForResource

DeleteReplicationGroup

module Network.AWS.ElastiCache.DeleteReplicationGroup

PurchaseReservedCacheNodesOffering

module Network.AWS.ElastiCache.PurchaseReservedCacheNodesOffering

DescribeCacheClusters (Paginated)

module Network.AWS.ElastiCache.DescribeCacheClusters

ModifyReplicationGroup

module Network.AWS.ElastiCache.ModifyReplicationGroup

RemoveTagsFromResource

module Network.AWS.ElastiCache.RemoveTagsFromResource

DescribeCacheParameters (Paginated)

module Network.AWS.ElastiCache.DescribeCacheParameters

DescribeCacheSubnetGroups (Paginated)

module Network.AWS.ElastiCache.DescribeCacheSubnetGroups

CreateCacheSecurityGroup

module Network.AWS.ElastiCache.CreateCacheSecurityGroup

AddTagsToResource

module Network.AWS.ElastiCache.AddTagsToResource

AuthorizeCacheSecurityGroupIngress

module Network.AWS.ElastiCache.AuthorizeCacheSecurityGroupIngress

CopySnapshot

module Network.AWS.ElastiCache.CopySnapshot

CreateCacheSubnetGroup

module Network.AWS.ElastiCache.CreateCacheSubnetGroup

DescribeCacheParameterGroups (Paginated)

module Network.AWS.ElastiCache.DescribeCacheParameterGroups

ResetCacheParameterGroup

module Network.AWS.ElastiCache.ResetCacheParameterGroup

DescribeSnapshots (Paginated)

module Network.AWS.ElastiCache.DescribeSnapshots

DescribeReservedCacheNodesOfferings (Paginated)

module Network.AWS.ElastiCache.DescribeReservedCacheNodesOfferings

DeleteSnapshot

module Network.AWS.ElastiCache.DeleteSnapshot

DescribeReplicationGroups (Paginated)

module Network.AWS.ElastiCache.DescribeReplicationGroups

ModifyCacheSubnetGroup

module Network.AWS.ElastiCache.ModifyCacheSubnetGroup

CreateSnapshot

module Network.AWS.ElastiCache.CreateSnapshot

DescribeCacheSecurityGroups (Paginated)

module Network.AWS.ElastiCache.DescribeCacheSecurityGroups

DeleteCacheParameterGroup

module Network.AWS.ElastiCache.DeleteCacheParameterGroup

DescribeReservedCacheNodes (Paginated)

module Network.AWS.ElastiCache.DescribeReservedCacheNodes

DescribeCacheEngineVersions (Paginated)

module Network.AWS.ElastiCache.DescribeCacheEngineVersions

ModifyCacheCluster

module Network.AWS.ElastiCache.ModifyCacheCluster

CreateCacheParameterGroup

module Network.AWS.ElastiCache.CreateCacheParameterGroup

DeleteCacheSubnetGroup

module Network.AWS.ElastiCache.DeleteCacheSubnetGroup

Types

AZMode

data AZMode

Constructors

CrossAz

SingleAz

Instances

Enum AZMode

Eq AZMode

Data AZMode

Ord AZMode

Read AZMode

Show AZMode

Generic AZMode

Hashable AZMode

ToHeader AZMode

ToQuery AZMode

ToByteString AZMode

FromText AZMode

ToText AZMode

Typeable * AZMode

type Rep AZMode

AutomaticFailoverStatus

data AutomaticFailoverStatus

Constructors

AFSDisabled

AFSDisabling

AFSEnabled

AFSEnabling

Instances

Enum AutomaticFailoverStatus

Eq AutomaticFailoverStatus

Data AutomaticFailoverStatus

Ord AutomaticFailoverStatus

Read AutomaticFailoverStatus

Show AutomaticFailoverStatus

Generic AutomaticFailoverStatus

Hashable AutomaticFailoverStatus

ToHeader AutomaticFailoverStatus

FromXML AutomaticFailoverStatus

ToQuery AutomaticFailoverStatus

ToByteString AutomaticFailoverStatus

FromText AutomaticFailoverStatus

ToText AutomaticFailoverStatus

Typeable * AutomaticFailoverStatus

type Rep AutomaticFailoverStatus

PendingAutomaticFailoverStatus

data PendingAutomaticFailoverStatus

Constructors

Disabled

Enabled

Instances

Enum PendingAutomaticFailoverStatus

Eq PendingAutomaticFailoverStatus

Data PendingAutomaticFailoverStatus

Ord PendingAutomaticFailoverStatus

Read PendingAutomaticFailoverStatus

Show PendingAutomaticFailoverStatus

Generic PendingAutomaticFailoverStatus

Hashable PendingAutomaticFailoverStatus

ToHeader PendingAutomaticFailoverStatus

FromXML PendingAutomaticFailoverStatus

ToQuery PendingAutomaticFailoverStatus

ToByteString PendingAutomaticFailoverStatus

FromText PendingAutomaticFailoverStatus

ToText PendingAutomaticFailoverStatus

Typeable * PendingAutomaticFailoverStatus

type Rep PendingAutomaticFailoverStatus

SourceType

data SourceType

Constructors

CacheCluster

CacheParameterGroup

CacheSecurityGroup

CacheSubnetGroup

Instances

Enum SourceType

Eq SourceType

Data SourceType

Ord SourceType

Read SourceType

Show SourceType

Generic SourceType

Hashable SourceType

ToHeader SourceType

FromXML SourceType

ToQuery SourceType

ToByteString SourceType

FromText SourceType

ToText SourceType

Typeable * SourceType

type Rep SourceType

AvailabilityZone

data AvailabilityZone

Describes an Availability Zone in which the cache cluster is launched.

See: availabilityZone smart constructor.

Instances

Eq AvailabilityZone

Data AvailabilityZone

Read AvailabilityZone

Show AvailabilityZone

Generic AvailabilityZone

FromXML AvailabilityZone

Typeable * AvailabilityZone

type Rep AvailabilityZone

availabilityZone :: AvailabilityZone

Creates a value of AvailabilityZone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• azName

azName :: Lens' AvailabilityZone (Maybe Text)

The name of the Availability Zone.

CacheCluster

data CacheCluster

Contains all of the attributes of a specific cache cluster.

See: cacheCluster smart constructor.

Instances

Eq CacheCluster

Data CacheCluster

Read CacheCluster

Show CacheCluster

Generic CacheCluster

FromXML CacheCluster

Typeable * CacheCluster

type Rep CacheCluster

cacheCluster :: CacheCluster

Creates a value of CacheCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ccCacheNodeType
• ccEngineVersion
• ccCacheNodes
• ccCacheClusterCreateTime
• ccAutoMinorVersionUpgrade
• ccSecurityGroups
• ccNotificationConfiguration
• ccSnapshotWindow
• ccCacheClusterId
• ccConfigurationEndpoint
• ccEngine
• ccCacheSecurityGroups
• ccClientDownloadLandingPage
• ccPreferredMaintenanceWindow
• ccCacheSubnetGroupName
• ccCacheClusterStatus
• ccPreferredAvailabilityZone
• ccCacheParameterGroup
• ccSnapshotRetentionLimit
• ccReplicationGroupId
• ccPendingModifiedValues
• ccNumCacheNodes

ccCacheNodeType :: Lens' CacheCluster (Maybe Text)

The name of the compute and memory capacity node type for the cache cluster.

Valid node types are as follows:

• General purpose:
• Current generation: 'cache.t2.micro', 'cache.t2.small', 'cache.t2.medium', 'cache.m3.medium', 'cache.m3.large', 'cache.m3.xlarge', 'cache.m3.2xlarge'
• Previous generation: 'cache.t1.micro', 'cache.m1.small', 'cache.m1.medium', 'cache.m1.large', 'cache.m1.xlarge'
• Compute optimized: 'cache.c1.xlarge'
• Memory optimized
• Current generation: 'cache.r3.large', 'cache.r3.xlarge', 'cache.r3.2xlarge', 'cache.r3.4xlarge', 'cache.r3.8xlarge'
• Previous generation: 'cache.m2.xlarge', 'cache.m2.2xlarge', 'cache.m2.4xlarge'

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

ccEngineVersion :: Lens' CacheCluster (Maybe Text)

The version of the cache engine version that is used in this cache cluster.

ccCacheNodes :: Lens' CacheCluster [CacheNode]

A list of cache nodes that are members of the cache cluster.

ccCacheClusterCreateTime :: Lens' CacheCluster (Maybe UTCTime)

The date and time when the cache cluster was created.

ccAutoMinorVersionUpgrade :: Lens' CacheCluster (Maybe Bool)

This parameter is currently disabled.

ccSecurityGroups :: Lens' CacheCluster [SecurityGroupMembership]

A list of VPC Security Groups associated with the cache cluster.

ccNotificationConfiguration :: Lens' CacheCluster (Maybe NotificationConfiguration)

Undocumented member.

ccSnapshotWindow :: Lens' CacheCluster (Maybe Text)

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Example: '05:00-09:00'

ccCacheClusterId :: Lens' CacheCluster (Maybe Text)

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

ccConfigurationEndpoint :: Lens' CacheCluster (Maybe Endpoint)

Undocumented member.

ccEngine :: Lens' CacheCluster (Maybe Text)

The name of the cache engine (memcached or redis) to be used for this cache cluster.

ccCacheSecurityGroups :: Lens' CacheCluster [CacheSecurityGroupMembership]

A list of cache security group elements, composed of name and status sub-elements.

ccClientDownloadLandingPage :: Lens' CacheCluster (Maybe Text)

The URL of the web page where you can download the latest ElastiCache client library.

ccPreferredMaintenanceWindow :: Lens' CacheCluster (Maybe Text)

Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

• sun
• mon
• tue
• wed
• thu
• fri
• sat

Example: 'sun:05:00-sun:09:00'

ccCacheSubnetGroupName :: Lens' CacheCluster (Maybe Text)

The name of the cache subnet group associated with the cache cluster.

ccCacheClusterStatus :: Lens' CacheCluster (Maybe Text)

The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

ccPreferredAvailabilityZone :: Lens' CacheCluster (Maybe Text)

The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

ccCacheParameterGroup :: Lens' CacheCluster (Maybe CacheParameterGroupStatus)

Undocumented member.

ccSnapshotRetentionLimit :: Lens' CacheCluster (Maybe Int)

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

ccReplicationGroupId :: Lens' CacheCluster (Maybe Text)

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

ccPendingModifiedValues :: Lens' CacheCluster (Maybe PendingModifiedValues)

Undocumented member.

ccNumCacheNodes :: Lens' CacheCluster (Maybe Int)

The number of cache nodes in the cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

CacheEngineVersion

data CacheEngineVersion

Provides all of the details about a particular cache engine version.

See: cacheEngineVersion smart constructor.

Instances

Eq CacheEngineVersion

Data CacheEngineVersion

Read CacheEngineVersion

Show CacheEngineVersion

Generic CacheEngineVersion

FromXML CacheEngineVersion

Typeable * CacheEngineVersion

type Rep CacheEngineVersion

cacheEngineVersion :: CacheEngineVersion

Creates a value of CacheEngineVersion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cevCacheEngineDescription
• cevCacheParameterGroupFamily
• cevEngineVersion
• cevCacheEngineVersionDescription
• cevEngine

cevCacheEngineDescription :: Lens' CacheEngineVersion (Maybe Text)

The description of the cache engine.

cevCacheParameterGroupFamily :: Lens' CacheEngineVersion (Maybe Text)

The name of the cache parameter group family associated with this cache engine.

cevEngineVersion :: Lens' CacheEngineVersion (Maybe Text)

The version number of the cache engine.

cevCacheEngineVersionDescription :: Lens' CacheEngineVersion (Maybe Text)

The description of the cache engine version.

cevEngine :: Lens' CacheEngineVersion (Maybe Text)

The name of the cache engine.

CacheNode

data CacheNode

Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

Valid node types are as follows:

• General purpose:
• Current generation: 'cache.t2.micro', 'cache.t2.small', 'cache.t2.medium', 'cache.m3.medium', 'cache.m3.large', 'cache.m3.xlarge', 'cache.m3.2xlarge'
• Previous generation: 'cache.t1.micro', 'cache.m1.small', 'cache.m1.medium', 'cache.m1.large', 'cache.m1.xlarge'
• Compute optimized: 'cache.c1.xlarge'
• Memory optimized
• Current generation: 'cache.r3.large', 'cache.r3.xlarge', 'cache.r3.2xlarge', 'cache.r3.4xlarge', 'cache.r3.8xlarge'
• Previous generation: 'cache.m2.xlarge', 'cache.m2.2xlarge', 'cache.m2.4xlarge'

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

See: cacheNode smart constructor.

Instances

Eq CacheNode

Data CacheNode

Read CacheNode

Show CacheNode

Generic CacheNode

FromXML CacheNode

Typeable * CacheNode

type Rep CacheNode

cacheNode :: CacheNode

Creates a value of CacheNode with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cnSourceCacheNodeId
• cnParameterGroupStatus
• cnCacheNodeCreateTime
• cnCustomerAvailabilityZone
• cnCacheNodeId
• cnCacheNodeStatus
• cnEndpoint

cnSourceCacheNodeId :: Lens' CacheNode (Maybe Text)

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

cnParameterGroupStatus :: Lens' CacheNode (Maybe Text)

The status of the parameter group applied to this cache node.

cnCacheNodeCreateTime :: Lens' CacheNode (Maybe UTCTime)

The date and time when the cache node was created.

cnCustomerAvailabilityZone :: Lens' CacheNode (Maybe Text)

The Availability Zone where this node was created and now resides.

cnCacheNodeId :: Lens' CacheNode (Maybe Text)

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

cnCacheNodeStatus :: Lens' CacheNode (Maybe Text)

The current state of this cache node.

cnEndpoint :: Lens' CacheNode (Maybe Endpoint)

The hostname for connecting to this cache node.

CacheNodeTypeSpecificParameter

data CacheNodeTypeSpecificParameter

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

See: cacheNodeTypeSpecificParameter smart constructor.

Instances

Eq CacheNodeTypeSpecificParameter

Data CacheNodeTypeSpecificParameter

Read CacheNodeTypeSpecificParameter

Show CacheNodeTypeSpecificParameter

Generic CacheNodeTypeSpecificParameter

FromXML CacheNodeTypeSpecificParameter

Typeable * CacheNodeTypeSpecificParameter

type Rep CacheNodeTypeSpecificParameter

cacheNodeTypeSpecificParameter :: CacheNodeTypeSpecificParameter

Creates a value of CacheNodeTypeSpecificParameter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cntspCacheNodeTypeSpecificValues
• cntspMinimumEngineVersion
• cntspSource
• cntspIsModifiable
• cntspAllowedValues
• cntspDataType
• cntspParameterName
• cntspDescription

cntspCacheNodeTypeSpecificValues :: Lens' CacheNodeTypeSpecificParameter [CacheNodeTypeSpecificValue]

A list of cache node types and their corresponding values for this parameter.

cntspMinimumEngineVersion :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The earliest cache engine version to which the parameter can apply.

cntspSource :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The source of the parameter value.

cntspIsModifiable :: Lens' CacheNodeTypeSpecificParameter (Maybe Bool)

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

cntspAllowedValues :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The valid range of values for the parameter.

cntspDataType :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The valid data type for the parameter.

cntspParameterName :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

The name of the parameter.

cntspDescription :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)

A description of the parameter.

CacheNodeTypeSpecificValue

data CacheNodeTypeSpecificValue

A value that applies only to a certain cache node type.

See: cacheNodeTypeSpecificValue smart constructor.

Instances

Eq CacheNodeTypeSpecificValue

Data CacheNodeTypeSpecificValue

Read CacheNodeTypeSpecificValue

Show CacheNodeTypeSpecificValue

Generic CacheNodeTypeSpecificValue

FromXML CacheNodeTypeSpecificValue

Typeable * CacheNodeTypeSpecificValue

type Rep CacheNodeTypeSpecificValue

cacheNodeTypeSpecificValue :: CacheNodeTypeSpecificValue

Creates a value of CacheNodeTypeSpecificValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cntsvCacheNodeType
• cntsvValue

cntsvCacheNodeType :: Lens' CacheNodeTypeSpecificValue (Maybe Text)

The cache node type for which this value applies.

cntsvValue :: Lens' CacheNodeTypeSpecificValue (Maybe Text)

The value for the cache node type.

CacheParameterGroup

data CacheParameterGroup

Represents the output of a CreateCacheParameterGroup action.

See: cacheParameterGroup smart constructor.

Instances

Eq CacheParameterGroup

Data CacheParameterGroup

Read CacheParameterGroup

Show CacheParameterGroup

Generic CacheParameterGroup

FromXML CacheParameterGroup

Typeable * CacheParameterGroup

type Rep CacheParameterGroup

cacheParameterGroup :: CacheParameterGroup

Creates a value of CacheParameterGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cpgCacheParameterGroupFamily
• cpgCacheParameterGroupName
• cpgDescription

cpgCacheParameterGroupFamily :: Lens' CacheParameterGroup (Maybe Text)

The name of the cache parameter group family that this cache parameter group is compatible with.

cpgCacheParameterGroupName :: Lens' CacheParameterGroup (Maybe Text)

The name of the cache parameter group.

cpgDescription :: Lens' CacheParameterGroup (Maybe Text)

The description for this cache parameter group.

CacheParameterGroupNameMessage

data CacheParameterGroupNameMessage

Represents the output of one of the following actions:

• ModifyCacheParameterGroup
• ResetCacheParameterGroup

See: cacheParameterGroupNameMessage smart constructor.

Instances

Eq CacheParameterGroupNameMessage

Data CacheParameterGroupNameMessage

Read CacheParameterGroupNameMessage

Show CacheParameterGroupNameMessage

Generic CacheParameterGroupNameMessage

FromXML CacheParameterGroupNameMessage

Typeable * CacheParameterGroupNameMessage

type Rep CacheParameterGroupNameMessage

cacheParameterGroupNameMessage :: CacheParameterGroupNameMessage

Creates a value of CacheParameterGroupNameMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cpgnmCacheParameterGroupName

cpgnmCacheParameterGroupName :: Lens' CacheParameterGroupNameMessage (Maybe Text)

The name of the cache parameter group.

CacheParameterGroupStatus

data CacheParameterGroupStatus

The status of the cache parameter group.

See: cacheParameterGroupStatus smart constructor.

Instances

Eq CacheParameterGroupStatus

Data CacheParameterGroupStatus

Read CacheParameterGroupStatus

Show CacheParameterGroupStatus

Generic CacheParameterGroupStatus

FromXML CacheParameterGroupStatus

Typeable * CacheParameterGroupStatus

type Rep CacheParameterGroupStatus

cacheParameterGroupStatus :: CacheParameterGroupStatus

Creates a value of CacheParameterGroupStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cpgsCacheParameterGroupName
• cpgsCacheNodeIdsToReboot
• cpgsParameterApplyStatus

cpgsCacheParameterGroupName :: Lens' CacheParameterGroupStatus (Maybe Text)

The name of the cache parameter group.

cpgsCacheNodeIdsToReboot :: Lens' CacheParameterGroupStatus [Text]

A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

cpgsParameterApplyStatus :: Lens' CacheParameterGroupStatus (Maybe Text)

The status of parameter updates.

CacheSecurityGroup

data CacheSecurityGroup

Represents the output of one of the following actions:

• AuthorizeCacheSecurityGroupIngress
• CreateCacheSecurityGroup
• RevokeCacheSecurityGroupIngress

See: cacheSecurityGroup smart constructor.

Instances

Eq CacheSecurityGroup

Data CacheSecurityGroup

Read CacheSecurityGroup

Show CacheSecurityGroup

Generic CacheSecurityGroup

FromXML CacheSecurityGroup

Typeable * CacheSecurityGroup

type Rep CacheSecurityGroup

cacheSecurityGroup :: CacheSecurityGroup

Creates a value of CacheSecurityGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csgCacheSecurityGroupName
• csgOwnerId
• csgEC2SecurityGroups
• csgDescription

csgCacheSecurityGroupName :: Lens' CacheSecurityGroup (Maybe Text)

The name of the cache security group.

csgOwnerId :: Lens' CacheSecurityGroup (Maybe Text)

The AWS account ID of the cache security group owner.

csgEC2SecurityGroups :: Lens' CacheSecurityGroup [EC2SecurityGroup]

A list of Amazon EC2 security groups that are associated with this cache security group.

csgDescription :: Lens' CacheSecurityGroup (Maybe Text)

The description of the cache security group.

CacheSecurityGroupMembership

data CacheSecurityGroupMembership

Represents a cache cluster's status within a particular cache security group.

See: cacheSecurityGroupMembership smart constructor.

Instances

Eq CacheSecurityGroupMembership

Data CacheSecurityGroupMembership

Read CacheSecurityGroupMembership

Show CacheSecurityGroupMembership

Generic CacheSecurityGroupMembership

FromXML CacheSecurityGroupMembership

Typeable * CacheSecurityGroupMembership

type Rep CacheSecurityGroupMembership

cacheSecurityGroupMembership :: CacheSecurityGroupMembership

Creates a value of CacheSecurityGroupMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csgmStatus
• csgmCacheSecurityGroupName

csgmStatus :: Lens' CacheSecurityGroupMembership (Maybe Text)

The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

csgmCacheSecurityGroupName :: Lens' CacheSecurityGroupMembership (Maybe Text)

The name of the cache security group.

CacheSubnetGroup

data CacheSubnetGroup

Represents the output of one of the following actions:

• CreateCacheSubnetGroup
• ModifyCacheSubnetGroup

See: cacheSubnetGroup smart constructor.

Instances

Eq CacheSubnetGroup

Data CacheSubnetGroup

Read CacheSubnetGroup

Show CacheSubnetGroup

Generic CacheSubnetGroup

FromXML CacheSubnetGroup

Typeable * CacheSubnetGroup

type Rep CacheSubnetGroup

cacheSubnetGroup :: CacheSubnetGroup

Creates a value of CacheSubnetGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csgVPCId
• csgSubnets
• csgCacheSubnetGroupName
• csgCacheSubnetGroupDescription

csgVPCId :: Lens' CacheSubnetGroup (Maybe Text)

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

csgSubnets :: Lens' CacheSubnetGroup [Subnet]

A list of subnets associated with the cache subnet group.

csgCacheSubnetGroupName :: Lens' CacheSubnetGroup (Maybe Text)

The name of the cache subnet group.

csgCacheSubnetGroupDescription :: Lens' CacheSubnetGroup (Maybe Text)

The description of the cache subnet group.

EC2SecurityGroup

data EC2SecurityGroup

Provides ownership and status information for an Amazon EC2 security group.

See: ec2SecurityGroup smart constructor.

Instances

Eq EC2SecurityGroup

Data EC2SecurityGroup

Read EC2SecurityGroup

Show EC2SecurityGroup

Generic EC2SecurityGroup

FromXML EC2SecurityGroup

Typeable * EC2SecurityGroup

type Rep EC2SecurityGroup

ec2SecurityGroup :: EC2SecurityGroup

Creates a value of EC2SecurityGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esgStatus
• esgEC2SecurityGroupOwnerId
• esgEC2SecurityGroupName

esgStatus :: Lens' EC2SecurityGroup (Maybe Text)

The status of the Amazon EC2 security group.

esgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text)

The AWS account ID of the Amazon EC2 security group owner.

esgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text)

The name of the Amazon EC2 security group.

Endpoint

data Endpoint

Represents the information required for client programs to connect to a cache node.

See: endpoint smart constructor.

Instances

Eq Endpoint

Data Endpoint

Read Endpoint

Show Endpoint

Generic Endpoint

FromXML Endpoint

Typeable * Endpoint

type Rep Endpoint

endpoint :: Endpoint

Creates a value of Endpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eAddress
• ePort

eAddress :: Lens' Endpoint (Maybe Text)

The DNS hostname of the cache node.

ePort :: Lens' Endpoint (Maybe Int)

The port number that the cache engine is listening on.

EngineDefaults

data EngineDefaults

Represents the output of a DescribeEngineDefaultParameters action.

See: engineDefaults smart constructor.

Instances

Eq EngineDefaults

Data EngineDefaults

Read EngineDefaults

Show EngineDefaults

Generic EngineDefaults

FromXML EngineDefaults

Typeable * EngineDefaults

type Rep EngineDefaults

engineDefaults :: EngineDefaults

Creates a value of EngineDefaults with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• edCacheParameterGroupFamily
• edCacheNodeTypeSpecificParameters
• edParameters
• edMarker

edCacheParameterGroupFamily :: Lens' EngineDefaults (Maybe Text)

Specifies the name of the cache parameter group family to which the engine default parameters apply.

edCacheNodeTypeSpecificParameters :: Lens' EngineDefaults [CacheNodeTypeSpecificParameter]

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

edParameters :: Lens' EngineDefaults [Parameter]

Contains a list of engine default parameters.

edMarker :: Lens' EngineDefaults (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

Event

data Event

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.

See: event smart constructor.

Instances

Eq Event

Data Event

Read Event

Show Event

Generic Event

FromXML Event

Typeable * Event

type Rep Event

event :: Event

Creates a value of Event with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eSourceType
• eSourceIdentifier
• eDate
• eMessage

eSourceType :: Lens' Event (Maybe SourceType)

Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

eSourceIdentifier :: Lens' Event (Maybe Text)

The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.

eDate :: Lens' Event (Maybe UTCTime)

The date and time when the event occurred.

eMessage :: Lens' Event (Maybe Text)

The text of the event.

NodeGroup

data NodeGroup

Represents a collection of cache nodes in a replication group.

See: nodeGroup smart constructor.

Instances

Eq NodeGroup

Data NodeGroup

Read NodeGroup

Show NodeGroup

Generic NodeGroup

FromXML NodeGroup

Typeable * NodeGroup

type Rep NodeGroup

nodeGroup :: NodeGroup

Creates a value of NodeGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ngStatus
• ngPrimaryEndpoint
• ngNodeGroupMembers
• ngNodeGroupId

ngStatus :: Lens' NodeGroup (Maybe Text)

The current state of this replication group - creating, available, etc.

ngPrimaryEndpoint :: Lens' NodeGroup (Maybe Endpoint)

Undocumented member.

ngNodeGroupMembers :: Lens' NodeGroup [NodeGroupMember]

A list containing information about individual nodes within the node group.

ngNodeGroupId :: Lens' NodeGroup (Maybe Text)

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

NodeGroupMember

data NodeGroupMember

Represents a single node within a node group.

See: nodeGroupMember smart constructor.

Instances

Eq NodeGroupMember

Data NodeGroupMember

Read NodeGroupMember

Show NodeGroupMember

Generic NodeGroupMember

FromXML NodeGroupMember

Typeable * NodeGroupMember

type Rep NodeGroupMember

nodeGroupMember :: NodeGroupMember

Creates a value of NodeGroupMember with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ngmCacheClusterId
• ngmCacheNodeId
• ngmPreferredAvailabilityZone
• ngmCurrentRole
• ngmReadEndpoint

ngmCacheClusterId :: Lens' NodeGroupMember (Maybe Text)

The ID of the cache cluster to which the node belongs.

ngmCacheNodeId :: Lens' NodeGroupMember (Maybe Text)

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

ngmPreferredAvailabilityZone :: Lens' NodeGroupMember (Maybe Text)

The name of the Availability Zone in which the node is located.

ngmCurrentRole :: Lens' NodeGroupMember (Maybe Text)

The role that is currently assigned to the node - primary or replica.

ngmReadEndpoint :: Lens' NodeGroupMember (Maybe Endpoint)

Undocumented member.

NodeSnapshot

data NodeSnapshot

Represents an individual cache node in a snapshot of a cache cluster.

See: nodeSnapshot smart constructor.

Instances

Eq NodeSnapshot

Data NodeSnapshot

Read NodeSnapshot

Show NodeSnapshot

Generic NodeSnapshot

FromXML NodeSnapshot

Typeable * NodeSnapshot

type Rep NodeSnapshot

nodeSnapshot :: NodeSnapshot

Creates a value of NodeSnapshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• nsCacheNodeCreateTime
• nsCacheNodeId
• nsSnapshotCreateTime
• nsCacheSize

nsCacheNodeCreateTime :: Lens' NodeSnapshot (Maybe UTCTime)

The date and time when the cache node was created in the source cache cluster.

nsCacheNodeId :: Lens' NodeSnapshot (Maybe Text)

The cache node identifier for the node in the source cache cluster.

nsSnapshotCreateTime :: Lens' NodeSnapshot (Maybe UTCTime)

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

nsCacheSize :: Lens' NodeSnapshot (Maybe Text)

The size of the cache on the source cache node.

NotificationConfiguration

data NotificationConfiguration

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

See: notificationConfiguration smart constructor.

Instances

Eq NotificationConfiguration

Data NotificationConfiguration

Read NotificationConfiguration

Show NotificationConfiguration

Generic NotificationConfiguration

FromXML NotificationConfiguration

Typeable * NotificationConfiguration

type Rep NotificationConfiguration

notificationConfiguration :: NotificationConfiguration

Creates a value of NotificationConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ncTopicStatus
• ncTopicARN

ncTopicStatus :: Lens' NotificationConfiguration (Maybe Text)

The current state of the topic.

ncTopicARN :: Lens' NotificationConfiguration (Maybe Text)

The Amazon Resource Name (ARN) that identifies the topic.

Parameter

data Parameter

Describes an individual setting that controls some aspect of ElastiCache behavior.

See: parameter smart constructor.

Instances

Eq Parameter

Data Parameter

Read Parameter

Show Parameter

Generic Parameter

FromXML Parameter

Typeable * Parameter

type Rep Parameter

parameter :: Parameter

Creates a value of Parameter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pParameterValue
• pMinimumEngineVersion
• pSource
• pIsModifiable
• pAllowedValues
• pDataType
• pParameterName
• pDescription

pParameterValue :: Lens' Parameter (Maybe Text)

The value of the parameter.

pMinimumEngineVersion :: Lens' Parameter (Maybe Text)

The earliest cache engine version to which the parameter can apply.

pSource :: Lens' Parameter (Maybe Text)

The source of the parameter.

pIsModifiable :: Lens' Parameter (Maybe Bool)

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

pAllowedValues :: Lens' Parameter (Maybe Text)

The valid range of values for the parameter.

pDataType :: Lens' Parameter (Maybe Text)

The valid data type for the parameter.

pParameterName :: Lens' Parameter (Maybe Text)

The name of the parameter.

pDescription :: Lens' Parameter (Maybe Text)

A description of the parameter.

ParameterNameValue

data ParameterNameValue

Describes a name-value pair that is used to update the value of a parameter.

See: parameterNameValue smart constructor.

Instances

Eq ParameterNameValue

Data ParameterNameValue

Read ParameterNameValue

Show ParameterNameValue

Generic ParameterNameValue

ToQuery ParameterNameValue

Typeable * ParameterNameValue

type Rep ParameterNameValue

parameterNameValue :: ParameterNameValue

Creates a value of ParameterNameValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pnvParameterValue
• pnvParameterName

pnvParameterValue :: Lens' ParameterNameValue (Maybe Text)

The value of the parameter.

pnvParameterName :: Lens' ParameterNameValue (Maybe Text)

The name of the parameter.

PendingModifiedValues

data PendingModifiedValues

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

See: pendingModifiedValues smart constructor.

Instances

Eq PendingModifiedValues

Data PendingModifiedValues

Read PendingModifiedValues

Show PendingModifiedValues

Generic PendingModifiedValues

FromXML PendingModifiedValues

Typeable * PendingModifiedValues

type Rep PendingModifiedValues

pendingModifiedValues :: PendingModifiedValues

Creates a value of PendingModifiedValues with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pmvEngineVersion
• pmvCacheNodeIdsToRemove
• pmvNumCacheNodes

pmvEngineVersion :: Lens' PendingModifiedValues (Maybe Text)

The new cache engine version that the cache cluster will run.

pmvCacheNodeIdsToRemove :: Lens' PendingModifiedValues [Text]

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

pmvNumCacheNodes :: Lens' PendingModifiedValues (Maybe Int)

The new number of cache nodes for the cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

RecurringCharge

data RecurringCharge

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

See: recurringCharge smart constructor.

Instances

Eq RecurringCharge

Data RecurringCharge

Read RecurringCharge

Show RecurringCharge

Generic RecurringCharge

FromXML RecurringCharge

Typeable * RecurringCharge

type Rep RecurringCharge

recurringCharge :: RecurringCharge

Creates a value of RecurringCharge with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rcRecurringChargeFrequency
• rcRecurringChargeAmount

rcRecurringChargeFrequency :: Lens' RecurringCharge (Maybe Text)

The frequency of the recurring charge.

rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double)

The monetary amount of the recurring charge.

ReplicationGroup

data ReplicationGroup

Contains all of the attributes of a specific replication group.

See: replicationGroup smart constructor.

Instances

Eq ReplicationGroup

Data ReplicationGroup

Read ReplicationGroup

Show ReplicationGroup

Generic ReplicationGroup

FromXML ReplicationGroup

Typeable * ReplicationGroup

type Rep ReplicationGroup

replicationGroup :: ReplicationGroup

Creates a value of ReplicationGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rgNodeGroups
• rgStatus
• rgSnapshottingClusterId
• rgMemberClusters
• rgReplicationGroupId
• rgPendingModifiedValues
• rgDescription
• rgAutomaticFailover

rgNodeGroups :: Lens' ReplicationGroup [NodeGroup]

A single element list with information about the nodes in the replication group.

rgStatus :: Lens' ReplicationGroup (Maybe Text)

The current state of this replication group - creating, available, etc.

rgSnapshottingClusterId :: Lens' ReplicationGroup (Maybe Text)

The cache cluster ID that is used as the daily snapshot source for the replication group.

rgMemberClusters :: Lens' ReplicationGroup [Text]

The names of all the cache clusters that are part of this replication group.

rgReplicationGroupId :: Lens' ReplicationGroup (Maybe Text)

The identifier for the replication group.

rgPendingModifiedValues :: Lens' ReplicationGroup (Maybe ReplicationGroupPendingModifiedValues)

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

rgDescription :: Lens' ReplicationGroup (Maybe Text)

The description of the replication group.

rgAutomaticFailover :: Lens' ReplicationGroup (Maybe AutomaticFailoverStatus)

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.
• T1 and T2 cache node types.

ReplicationGroupPendingModifiedValues

data ReplicationGroupPendingModifiedValues

The settings to be applied to the replication group, either immediately or during the next maintenance window.

See: replicationGroupPendingModifiedValues smart constructor.

Instances

Eq ReplicationGroupPendingModifiedValues

Data ReplicationGroupPendingModifiedValues

Read ReplicationGroupPendingModifiedValues

Show ReplicationGroupPendingModifiedValues

Generic ReplicationGroupPendingModifiedValues

FromXML ReplicationGroupPendingModifiedValues

Typeable * ReplicationGroupPendingModifiedValues

type Rep ReplicationGroupPendingModifiedValues

replicationGroupPendingModifiedValues :: ReplicationGroupPendingModifiedValues

Creates a value of ReplicationGroupPendingModifiedValues with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rgpmvPrimaryClusterId
• rgpmvAutomaticFailoverStatus

rgpmvPrimaryClusterId :: Lens' ReplicationGroupPendingModifiedValues (Maybe Text)

The primary cluster ID which will be applied immediately (if '--apply-immediately' was specified), or during the next maintenance window.

rgpmvAutomaticFailoverStatus :: Lens' ReplicationGroupPendingModifiedValues (Maybe PendingAutomaticFailoverStatus)

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.
• T1 and T2 cache node types.

ReservedCacheNode

data ReservedCacheNode

Represents the output of a PurchaseReservedCacheNodesOffering action.

See: reservedCacheNode smart constructor.

Instances

Eq ReservedCacheNode

Data ReservedCacheNode

Read ReservedCacheNode

Show ReservedCacheNode

Generic ReservedCacheNode

FromXML ReservedCacheNode

Typeable * ReservedCacheNode

type Rep ReservedCacheNode

reservedCacheNode :: ReservedCacheNode

Creates a value of ReservedCacheNode with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rcnCacheNodeType
• rcnState
• rcnProductDescription
• rcnStartTime
• rcnCacheNodeCount
• rcnReservedCacheNodeId
• rcnOfferingType
• rcnUsagePrice
• rcnRecurringCharges
• rcnFixedPrice
• rcnDuration
• rcnReservedCacheNodesOfferingId

rcnCacheNodeType :: Lens' ReservedCacheNode (Maybe Text)

The cache node type for the reserved cache nodes.

Valid node types are as follows:

• General purpose:
• Current generation: 'cache.t2.micro', 'cache.t2.small', 'cache.t2.medium', 'cache.m3.medium', 'cache.m3.large', 'cache.m3.xlarge', 'cache.m3.2xlarge'
• Previous generation: 'cache.t1.micro', 'cache.m1.small', 'cache.m1.medium', 'cache.m1.large', 'cache.m1.xlarge'
• Compute optimized: 'cache.c1.xlarge'
• Memory optimized
• Current generation: 'cache.r3.large', 'cache.r3.xlarge', 'cache.r3.2xlarge', 'cache.r3.4xlarge', 'cache.r3.8xlarge'
• Previous generation: 'cache.m2.xlarge', 'cache.m2.2xlarge', 'cache.m2.4xlarge'

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

rcnState :: Lens' ReservedCacheNode (Maybe Text)

The state of the reserved cache node.

rcnProductDescription :: Lens' ReservedCacheNode (Maybe Text)

The description of the reserved cache node.

rcnStartTime :: Lens' ReservedCacheNode (Maybe UTCTime)

The time the reservation started.

rcnCacheNodeCount :: Lens' ReservedCacheNode (Maybe Int)

The number of cache nodes that have been reserved.

rcnReservedCacheNodeId :: Lens' ReservedCacheNode (Maybe Text)

The unique identifier for the reservation.

rcnOfferingType :: Lens' ReservedCacheNode (Maybe Text)

The offering type of this reserved cache node.

rcnUsagePrice :: Lens' ReservedCacheNode (Maybe Double)

The hourly price charged for this reserved cache node.

rcnRecurringCharges :: Lens' ReservedCacheNode [RecurringCharge]

The recurring price charged to run this reserved cache node.

rcnFixedPrice :: Lens' ReservedCacheNode (Maybe Double)

The fixed price charged for this reserved cache node.

rcnDuration :: Lens' ReservedCacheNode (Maybe Int)

The duration of the reservation in seconds.

rcnReservedCacheNodesOfferingId :: Lens' ReservedCacheNode (Maybe Text)

The offering identifier.

ReservedCacheNodesOffering

data ReservedCacheNodesOffering

Describes all of the attributes of a reserved cache node offering.

See: reservedCacheNodesOffering smart constructor.

Instances

Eq ReservedCacheNodesOffering

Data ReservedCacheNodesOffering

Read ReservedCacheNodesOffering

Show ReservedCacheNodesOffering

Generic ReservedCacheNodesOffering

FromXML ReservedCacheNodesOffering

Typeable * ReservedCacheNodesOffering

type Rep ReservedCacheNodesOffering

reservedCacheNodesOffering :: ReservedCacheNodesOffering

Creates a value of ReservedCacheNodesOffering with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rcnoCacheNodeType
• rcnoProductDescription
• rcnoOfferingType
• rcnoUsagePrice
• rcnoRecurringCharges
• rcnoFixedPrice
• rcnoDuration
• rcnoReservedCacheNodesOfferingId

rcnoCacheNodeType :: Lens' ReservedCacheNodesOffering (Maybe Text)

The cache node type for the reserved cache node.

Valid node types are as follows:

• General purpose:
• Current generation: 'cache.t2.micro', 'cache.t2.small', 'cache.t2.medium', 'cache.m3.medium', 'cache.m3.large', 'cache.m3.xlarge', 'cache.m3.2xlarge'
• Previous generation: 'cache.t1.micro', 'cache.m1.small', 'cache.m1.medium', 'cache.m1.large', 'cache.m1.xlarge'
• Compute optimized: 'cache.c1.xlarge'
• Memory optimized
• Current generation: 'cache.r3.large', 'cache.r3.xlarge', 'cache.r3.2xlarge', 'cache.r3.4xlarge', 'cache.r3.8xlarge'
• Previous generation: 'cache.m2.xlarge', 'cache.m2.2xlarge', 'cache.m2.4xlarge'

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

rcnoProductDescription :: Lens' ReservedCacheNodesOffering (Maybe Text)

The cache engine used by the offering.

rcnoOfferingType :: Lens' ReservedCacheNodesOffering (Maybe Text)

The offering type.

rcnoUsagePrice :: Lens' ReservedCacheNodesOffering (Maybe Double)

The hourly price charged for this offering.

rcnoRecurringCharges :: Lens' ReservedCacheNodesOffering [RecurringCharge]

The recurring price charged to run this reserved cache node.

rcnoFixedPrice :: Lens' ReservedCacheNodesOffering (Maybe Double)

The fixed price charged for this offering.

rcnoDuration :: Lens' ReservedCacheNodesOffering (Maybe Int)

The duration of the offering. in seconds.

rcnoReservedCacheNodesOfferingId :: Lens' ReservedCacheNodesOffering (Maybe Text)

A unique identifier for the reserved cache node offering.

SecurityGroupMembership

data SecurityGroupMembership

Represents a single cache security group and its status.

See: securityGroupMembership smart constructor.

Instances

Eq SecurityGroupMembership

Data SecurityGroupMembership

Read SecurityGroupMembership

Show SecurityGroupMembership

Generic SecurityGroupMembership

FromXML SecurityGroupMembership

Typeable * SecurityGroupMembership

type Rep SecurityGroupMembership

securityGroupMembership :: SecurityGroupMembership

Creates a value of SecurityGroupMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sgmStatus
• sgmSecurityGroupId

sgmStatus :: Lens' SecurityGroupMembership (Maybe Text)

The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

sgmSecurityGroupId :: Lens' SecurityGroupMembership (Maybe Text)

The identifier of the cache security group.

Snapshot

data Snapshot

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

See: snapshot smart constructor.

Instances

Eq Snapshot

Data Snapshot

Read Snapshot

Show Snapshot

Generic Snapshot

FromXML Snapshot

Typeable * Snapshot

type Rep Snapshot

snapshot :: Snapshot

Creates a value of Snapshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sCacheNodeType
• sEngineVersion
• sCacheClusterCreateTime
• sAutoMinorVersionUpgrade
• sCacheParameterGroupName
• sSnapshotStatus
• sSnapshotWindow
• sVPCId
• sCacheClusterId
• sEngine
• sPreferredMaintenanceWindow
• sTopicARN
• sCacheSubnetGroupName
• sNodeSnapshots
• sPreferredAvailabilityZone
• sSnapshotRetentionLimit
• sSnapshotName
• sSnapshotSource
• sNumCacheNodes
• sPort

sCacheNodeType :: Lens' Snapshot (Maybe Text)

The name of the compute and memory capacity node type for the source cache cluster.

Valid node types are as follows:

• General purpose:
• Current generation: 'cache.t2.micro', 'cache.t2.small', 'cache.t2.medium', 'cache.m3.medium', 'cache.m3.large', 'cache.m3.xlarge', 'cache.m3.2xlarge'
• Previous generation: 'cache.t1.micro', 'cache.m1.small', 'cache.m1.medium', 'cache.m1.large', 'cache.m1.xlarge'
• Compute optimized: 'cache.c1.xlarge'
• Memory optimized
• Current generation: 'cache.r3.large', 'cache.r3.xlarge', 'cache.r3.2xlarge', 'cache.r3.4xlarge', 'cache.r3.8xlarge'
• Previous generation: 'cache.m2.xlarge', 'cache.m2.2xlarge', 'cache.m2.4xlarge'

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

sEngineVersion :: Lens' Snapshot (Maybe Text)

The version of the cache engine version that is used by the source cache cluster.

sCacheClusterCreateTime :: Lens' Snapshot (Maybe UTCTime)

The date and time when the source cache cluster was created.

sAutoMinorVersionUpgrade :: Lens' Snapshot (Maybe Bool)

This parameter is currently disabled.

sCacheParameterGroupName :: Lens' Snapshot (Maybe Text)

The cache parameter group that is associated with the source cache cluster.

sSnapshotStatus :: Lens' Snapshot (Maybe Text)

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

sSnapshotWindow :: Lens' Snapshot (Maybe Text)

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

sVPCId :: Lens' Snapshot (Maybe Text)

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

sCacheClusterId :: Lens' Snapshot (Maybe Text)

The user-supplied identifier of the source cache cluster.

sEngine :: Lens' Snapshot (Maybe Text)

The name of the cache engine (memcached or redis) used by the source cache cluster.

sPreferredMaintenanceWindow :: Lens' Snapshot (Maybe Text)

Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

• sun
• mon
• tue
• wed
• thu
• fri
• sat

Example: 'sun:05:00-sun:09:00'

sTopicARN :: Lens' Snapshot (Maybe Text)

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

sCacheSubnetGroupName :: Lens' Snapshot (Maybe Text)

The name of the cache subnet group associated with the source cache cluster.

sNodeSnapshots :: Lens' Snapshot [NodeSnapshot]

A list of the cache nodes in the source cache cluster.

sPreferredAvailabilityZone :: Lens' Snapshot (Maybe Text)

The name of the Availability Zone in which the source cache cluster is located.

sSnapshotRetentionLimit :: Lens' Snapshot (Maybe Int)

For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

sSnapshotName :: Lens' Snapshot (Maybe Text)

The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

sSnapshotSource :: Lens' Snapshot (Maybe Text)

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

sNumCacheNodes :: Lens' Snapshot (Maybe Int)

The number of cache nodes in the source cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

sPort :: Lens' Snapshot (Maybe Int)

The port number used by each cache nodes in the source cache cluster.

Subnet

data Subnet

Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

See: subnet smart constructor.

Instances

Eq Subnet

Data Subnet

Read Subnet

Show Subnet

Generic Subnet

FromXML Subnet

Typeable * Subnet

type Rep Subnet

subnet :: Subnet

Creates a value of Subnet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sSubnetIdentifier
• sSubnetAvailabilityZone

sSubnetIdentifier :: Lens' Subnet (Maybe Text)

The unique identifier for the subnet.

sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)

The Availability Zone associated with the subnet.

Tag

data Tag

A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

See: tag smart constructor.

Instances

Eq Tag

Data Tag

Read Tag

Show Tag

Generic Tag

FromXML Tag

ToQuery Tag

Typeable * Tag

type Rep Tag

tag :: Tag

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tagValue
• tagKey

tagValue :: Lens' Tag (Maybe Text)

The tag's value. May not be null.

tagKey :: Lens' Tag (Maybe Text)

The key for the tag.

TagListMessage

data TagListMessage

Represents the output from the AddTagsToResource, ListTagsOnResource, and RemoveTagsFromResource actions.

See: tagListMessage smart constructor.

Instances

Eq TagListMessage

Data TagListMessage

Read TagListMessage

Show TagListMessage

Generic TagListMessage

FromXML TagListMessage

Typeable * TagListMessage

type Rep TagListMessage

tagListMessage :: TagListMessage

Creates a value of TagListMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tlmTagList

tlmTagList :: Lens' TagListMessage [Tag]

A list of cost allocation tags as key-value pairs.