amazonka-elasticache-1.3.3.1: Amazon ElastiCache SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.Types

Contents

Description

 

Synopsis

Service Configuration

elastiCache :: Service Source

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

Errors

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

The requested cache subnet group is currently in use.

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

You already have a reservation with the given identifier.

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

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

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

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

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

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

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

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

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

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

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

The requested cache node offering does not exist.

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

The specified replication group does not exist.

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

An invalid subnet identifier was specified.

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

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.

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

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

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

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

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

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

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

You already have a snapshot with the given name.

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

The requested tag was not found on this resource.

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

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

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

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

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

A cache parameter group with the requested name already exists.

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

The requested reserved cache node was not found.

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

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

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

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.

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

The value for a parameter is invalid.

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

The requested replication group is not in the available state.

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

The specified replication group already exists.

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

The VPC network is in an invalid state.

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

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

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

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

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

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

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

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

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

The requested cache cluster is not in the available state.

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

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

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

You already have a cache cluster with the given identifier.

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

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

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

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

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

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

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

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

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

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

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

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

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

Two or more incompatible parameters were specified.

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

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

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

A cache security group with the specified name already exists.

AZMode

data AZMode Source

Constructors

CrossAz 
SingleAz 

Instances

AutomaticFailoverStatus

data AutomaticFailoverStatus Source

Constructors

AFSDisabled 
AFSDisabling 
AFSEnabled 
AFSEnabling 

Instances

PendingAutomaticFailoverStatus

data PendingAutomaticFailoverStatus Source

Constructors

Disabled 
Enabled 

Instances

SourceType

data SourceType Source

Constructors

CacheCluster 
CacheParameterGroup 
CacheSecurityGroup 
CacheSubnetGroup 

Instances

AvailabilityZone

data AvailabilityZone Source

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

See: availabilityZone smart constructor.

Instances

availabilityZone :: AvailabilityZone Source

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 :: Lens' AvailabilityZone (Maybe Text) Source

The name of the Availability Zone.

CacheCluster

data CacheCluster Source

Contains all of the attributes of a specific cache cluster.

See: cacheCluster smart constructor.

Instances

cacheCluster :: CacheCluster Source

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:

ccEngineVersion :: Lens' CacheCluster (Maybe Text) Source

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

ccCacheNodeType :: Lens' CacheCluster (Maybe Text) Source

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.

ccCacheNodes :: Lens' CacheCluster [CacheNode] Source

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

ccCacheClusterCreateTime :: Lens' CacheCluster (Maybe UTCTime) Source

The date and time when the cache cluster was created.

ccAutoMinorVersionUpgrade :: Lens' CacheCluster (Maybe Bool) Source

This parameter is currently disabled.

ccSecurityGroups :: Lens' CacheCluster [SecurityGroupMembership] Source

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

ccNotificationConfiguration :: Lens' CacheCluster (Maybe NotificationConfiguration) Source

Undocumented member.

ccSnapshotWindow :: Lens' CacheCluster (Maybe Text) Source

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) Source

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

ccConfigurationEndpoint :: Lens' CacheCluster (Maybe Endpoint) Source

Undocumented member.

ccEngine :: Lens' CacheCluster (Maybe Text) Source

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

ccCacheSecurityGroups :: Lens' CacheCluster [CacheSecurityGroupMembership] Source

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

ccClientDownloadLandingPage :: Lens' CacheCluster (Maybe Text) Source

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

ccPreferredMaintenanceWindow :: Lens' CacheCluster (Maybe Text) Source

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) Source

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

ccPreferredAvailabilityZone :: Lens' CacheCluster (Maybe Text) Source

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) Source

Undocumented member.

ccCacheClusterStatus :: Lens' CacheCluster (Maybe Text) Source

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.

ccSnapshotRetentionLimit :: Lens' CacheCluster (Maybe Int) Source

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) Source

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) Source

Undocumented member.

ccNumCacheNodes :: Lens' CacheCluster (Maybe Int) Source

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 Source

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

See: cacheEngineVersion smart constructor.

Instances

cacheEngineVersion :: CacheEngineVersion Source

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:

cevEngineVersion :: Lens' CacheEngineVersion (Maybe Text) Source

The version number of the cache engine.

cevCacheParameterGroupFamily :: Lens' CacheEngineVersion (Maybe Text) Source

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

cevCacheEngineDescription :: Lens' CacheEngineVersion (Maybe Text) Source

The description of the cache engine.

cevEngine :: Lens' CacheEngineVersion (Maybe Text) Source

The name of the cache engine.

cevCacheEngineVersionDescription :: Lens' CacheEngineVersion (Maybe Text) Source

The description of the cache engine version.

CacheNode

data CacheNode Source

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

cacheNode :: CacheNode Source

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 :: Lens' CacheNode (Maybe Text) Source

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) Source

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

cnCacheNodeCreateTime :: Lens' CacheNode (Maybe UTCTime) Source

The date and time when the cache node was created.

cnCustomerAvailabilityZone :: Lens' CacheNode (Maybe Text) Source

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

cnCacheNodeId :: Lens' CacheNode (Maybe Text) Source

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) Source

The current state of this cache node.

cnEndpoint :: Lens' CacheNode (Maybe Endpoint) Source

The hostname for connecting to this cache node.

CacheNodeTypeSpecificParameter

data CacheNodeTypeSpecificParameter Source

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

cacheNodeTypeSpecificParameter :: CacheNodeTypeSpecificParameter Source

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 :: Lens' CacheNodeTypeSpecificParameter [CacheNodeTypeSpecificValue] Source

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

cntspMinimumEngineVersion :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

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

cntspSource :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

The source of the parameter value.

cntspIsModifiable :: Lens' CacheNodeTypeSpecificParameter (Maybe Bool) Source

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

cntspDataType :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

The valid data type for the parameter.

cntspAllowedValues :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

The valid range of values for the parameter.

cntspParameterName :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

The name of the parameter.

cntspDescription :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

A description of the parameter.

CacheNodeTypeSpecificValue

data CacheNodeTypeSpecificValue Source

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

See: cacheNodeTypeSpecificValue smart constructor.

Instances

cacheNodeTypeSpecificValue :: CacheNodeTypeSpecificValue Source

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 :: Lens' CacheNodeTypeSpecificValue (Maybe Text) Source

The cache node type for which this value applies.

cntsvValue :: Lens' CacheNodeTypeSpecificValue (Maybe Text) Source

The value for the cache node type.

CacheParameterGroup

data CacheParameterGroup Source

Represents the output of a CreateCacheParameterGroup action.

See: cacheParameterGroup smart constructor.

Instances

cacheParameterGroup :: CacheParameterGroup Source

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 :: Lens' CacheParameterGroup (Maybe Text) Source

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

cpgCacheParameterGroupName :: Lens' CacheParameterGroup (Maybe Text) Source

The name of the cache parameter group.

cpgDescription :: Lens' CacheParameterGroup (Maybe Text) Source

The description for this cache parameter group.

CacheParameterGroupNameMessage

data CacheParameterGroupNameMessage Source

Represents the output of one of the following actions:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup

See: cacheParameterGroupNameMessage smart constructor.

Instances

cacheParameterGroupNameMessage :: CacheParameterGroupNameMessage Source

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 :: Lens' CacheParameterGroupNameMessage (Maybe Text) Source

The name of the cache parameter group.

CacheParameterGroupStatus

data CacheParameterGroupStatus Source

The status of the cache parameter group.

See: cacheParameterGroupStatus smart constructor.

Instances

cacheParameterGroupStatus :: CacheParameterGroupStatus Source

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 :: Lens' CacheParameterGroupStatus (Maybe Text) Source

The name of the cache parameter group.

cpgsCacheNodeIdsToReboot :: Lens' CacheParameterGroupStatus [Text] Source

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) Source

The status of parameter updates.

CacheSecurityGroup

data CacheSecurityGroup Source

Represents the output of one of the following actions:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress

See: cacheSecurityGroup smart constructor.

Instances

cacheSecurityGroup :: CacheSecurityGroup Source

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 :: Lens' CacheSecurityGroup (Maybe Text) Source

The name of the cache security group.

csgOwnerId :: Lens' CacheSecurityGroup (Maybe Text) Source

The AWS account ID of the cache security group owner.

csgEC2SecurityGroups :: Lens' CacheSecurityGroup [EC2SecurityGroup] Source

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

csgDescription :: Lens' CacheSecurityGroup (Maybe Text) Source

The description of the cache security group.

CacheSecurityGroupMembership

data CacheSecurityGroupMembership Source

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

See: cacheSecurityGroupMembership smart constructor.

Instances

cacheSecurityGroupMembership :: CacheSecurityGroupMembership Source

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 :: Lens' CacheSecurityGroupMembership (Maybe Text) Source

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) Source

The name of the cache security group.

CacheSubnetGroup

data CacheSubnetGroup Source

Represents the output of one of the following actions:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup

See: cacheSubnetGroup smart constructor.

Instances

cacheSubnetGroup :: CacheSubnetGroup Source

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 :: Lens' CacheSubnetGroup (Maybe Text) Source

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

csgSubnets :: Lens' CacheSubnetGroup [Subnet] Source

A list of subnets associated with the cache subnet group.

csgCacheSubnetGroupName :: Lens' CacheSubnetGroup (Maybe Text) Source

The name of the cache subnet group.

csgCacheSubnetGroupDescription :: Lens' CacheSubnetGroup (Maybe Text) Source

The description of the cache subnet group.

EC2SecurityGroup

data EC2SecurityGroup Source

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

See: ec2SecurityGroup smart constructor.

Instances

ec2SecurityGroup :: EC2SecurityGroup Source

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 :: Lens' EC2SecurityGroup (Maybe Text) Source

The status of the Amazon EC2 security group.

esgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) Source

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

esgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text) Source

The name of the Amazon EC2 security group.

Endpoint

data Endpoint Source

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

See: endpoint smart constructor.

Instances

endpoint :: Endpoint Source

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 :: Lens' Endpoint (Maybe Text) Source

The DNS hostname of the cache node.

ePort :: Lens' Endpoint (Maybe Int) Source

The port number that the cache engine is listening on.

EngineDefaults

data EngineDefaults Source

Represents the output of a DescribeEngineDefaultParameters action.

See: engineDefaults smart constructor.

Instances

engineDefaults :: EngineDefaults Source

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 :: Lens' EngineDefaults (Maybe Text) Source

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

edCacheNodeTypeSpecificParameters :: Lens' EngineDefaults [CacheNodeTypeSpecificParameter] Source

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

edMarker :: Lens' EngineDefaults (Maybe Text) Source

Provides an identifier to allow retrieval of paginated results.

edParameters :: Lens' EngineDefaults [Parameter] Source

Contains a list of engine default parameters.

Event

data Event Source

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

event :: Event Source

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 :: Lens' Event (Maybe SourceType) Source

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

eSourceIdentifier :: Lens' Event (Maybe Text) Source

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) Source

The date and time when the event occurred.

eMessage :: Lens' Event (Maybe Text) Source

The text of the event.

NodeGroup

data NodeGroup Source

Represents a collection of cache nodes in a replication group.

See: nodeGroup smart constructor.

Instances

nodeGroup :: NodeGroup Source

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 :: Lens' NodeGroup (Maybe Text) Source

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

ngPrimaryEndpoint :: Lens' NodeGroup (Maybe Endpoint) Source

Undocumented member.

ngNodeGroupMembers :: Lens' NodeGroup [NodeGroupMember] Source

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

ngNodeGroupId :: Lens' NodeGroup (Maybe Text) Source

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

NodeGroupMember

data NodeGroupMember Source

Represents a single node within a node group.

See: nodeGroupMember smart constructor.

Instances

nodeGroupMember :: NodeGroupMember Source

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 :: Lens' NodeGroupMember (Maybe Text) Source

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

ngmCacheNodeId :: Lens' NodeGroupMember (Maybe Text) Source

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

ngmPreferredAvailabilityZone :: Lens' NodeGroupMember (Maybe Text) Source

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

ngmCurrentRole :: Lens' NodeGroupMember (Maybe Text) Source

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

ngmReadEndpoint :: Lens' NodeGroupMember (Maybe Endpoint) Source

Undocumented member.

NodeSnapshot

data NodeSnapshot Source

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

See: nodeSnapshot smart constructor.

Instances

nodeSnapshot :: NodeSnapshot Source

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 :: Lens' NodeSnapshot (Maybe UTCTime) Source

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

nsCacheNodeId :: Lens' NodeSnapshot (Maybe Text) Source

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

nsSnapshotCreateTime :: Lens' NodeSnapshot (Maybe UTCTime) Source

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

nsCacheSize :: Lens' NodeSnapshot (Maybe Text) Source

The size of the cache on the source cache node.

NotificationConfiguration

data NotificationConfiguration Source

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

notificationConfiguration :: NotificationConfiguration Source

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 :: Lens' NotificationConfiguration (Maybe Text) Source

The current state of the topic.

ncTopicARN :: Lens' NotificationConfiguration (Maybe Text) Source

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

Parameter

data Parameter Source

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

See: parameter smart constructor.

Instances

parameter :: Parameter Source

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 :: Lens' Parameter (Maybe Text) Source

The value of the parameter.

pMinimumEngineVersion :: Lens' Parameter (Maybe Text) Source

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

pSource :: Lens' Parameter (Maybe Text) Source

The source of the parameter.

pIsModifiable :: Lens' Parameter (Maybe Bool) Source

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

pDataType :: Lens' Parameter (Maybe Text) Source

The valid data type for the parameter.

pAllowedValues :: Lens' Parameter (Maybe Text) Source

The valid range of values for the parameter.

pParameterName :: Lens' Parameter (Maybe Text) Source

The name of the parameter.

pDescription :: Lens' Parameter (Maybe Text) Source

A description of the parameter.

ParameterNameValue

data ParameterNameValue Source

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

See: parameterNameValue smart constructor.

Instances

parameterNameValue :: ParameterNameValue Source

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 :: Lens' ParameterNameValue (Maybe Text) Source

The value of the parameter.

pnvParameterName :: Lens' ParameterNameValue (Maybe Text) Source

The name of the parameter.

PendingModifiedValues

data PendingModifiedValues Source

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

pendingModifiedValues :: PendingModifiedValues Source

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 :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvCacheNodeIdsToRemove :: Lens' PendingModifiedValues [Text] Source

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) Source

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 Source

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

recurringCharge :: RecurringCharge Source

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 :: Lens' RecurringCharge (Maybe Text) Source

The frequency of the recurring charge.

rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source

The monetary amount of the recurring charge.

ReplicationGroup

data ReplicationGroup Source

Contains all of the attributes of a specific replication group.

See: replicationGroup smart constructor.

Instances

replicationGroup :: ReplicationGroup Source

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:

rgStatus :: Lens' ReplicationGroup (Maybe Text) Source

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

rgNodeGroups :: Lens' ReplicationGroup [NodeGroup] Source

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

rgSnapshottingClusterId :: Lens' ReplicationGroup (Maybe Text) Source

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

rgMemberClusters :: Lens' ReplicationGroup [Text] Source

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

rgDescription :: Lens' ReplicationGroup (Maybe Text) Source

The description of the replication group.

rgReplicationGroupId :: Lens' ReplicationGroup (Maybe Text) Source

The identifier for the replication group.

rgPendingModifiedValues :: Lens' ReplicationGroup (Maybe ReplicationGroupPendingModifiedValues) Source

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

rgAutomaticFailover :: Lens' ReplicationGroup (Maybe AutomaticFailoverStatus) Source

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 Source

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

See: replicationGroupPendingModifiedValues smart constructor.

Instances

replicationGroupPendingModifiedValues :: ReplicationGroupPendingModifiedValues Source

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 :: Lens' ReplicationGroupPendingModifiedValues (Maybe Text) Source

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) Source

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 Source

Represents the output of a PurchaseReservedCacheNodesOffering action.

See: reservedCacheNode smart constructor.

Instances

reservedCacheNode :: ReservedCacheNode Source

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 :: Lens' ReservedCacheNode (Maybe Text) Source

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) Source

The state of the reserved cache node.

rcnStartTime :: Lens' ReservedCacheNode (Maybe UTCTime) Source

The time the reservation started.

rcnProductDescription :: Lens' ReservedCacheNode (Maybe Text) Source

The description of the reserved cache node.

rcnCacheNodeCount :: Lens' ReservedCacheNode (Maybe Int) Source

The number of cache nodes that have been reserved.

rcnReservedCacheNodeId :: Lens' ReservedCacheNode (Maybe Text) Source

The unique identifier for the reservation.

rcnRecurringCharges :: Lens' ReservedCacheNode [RecurringCharge] Source

The recurring price charged to run this reserved cache node.

rcnOfferingType :: Lens' ReservedCacheNode (Maybe Text) Source

The offering type of this reserved cache node.

rcnUsagePrice :: Lens' ReservedCacheNode (Maybe Double) Source

The hourly price charged for this reserved cache node.

rcnFixedPrice :: Lens' ReservedCacheNode (Maybe Double) Source

The fixed price charged for this reserved cache node.

rcnDuration :: Lens' ReservedCacheNode (Maybe Int) Source

The duration of the reservation in seconds.

rcnReservedCacheNodesOfferingId :: Lens' ReservedCacheNode (Maybe Text) Source

The offering identifier.

ReservedCacheNodesOffering

data ReservedCacheNodesOffering Source

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

See: reservedCacheNodesOffering smart constructor.

Instances

reservedCacheNodesOffering :: ReservedCacheNodesOffering Source

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 :: Lens' ReservedCacheNodesOffering (Maybe Text) Source

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) Source

The cache engine used by the offering.

rcnoRecurringCharges :: Lens' ReservedCacheNodesOffering [RecurringCharge] Source

The recurring price charged to run this reserved cache node.

rcnoOfferingType :: Lens' ReservedCacheNodesOffering (Maybe Text) Source

The offering type.

rcnoUsagePrice :: Lens' ReservedCacheNodesOffering (Maybe Double) Source

The hourly price charged for this offering.

rcnoFixedPrice :: Lens' ReservedCacheNodesOffering (Maybe Double) Source

The fixed price charged for this offering.

rcnoDuration :: Lens' ReservedCacheNodesOffering (Maybe Int) Source

The duration of the offering. in seconds.

rcnoReservedCacheNodesOfferingId :: Lens' ReservedCacheNodesOffering (Maybe Text) Source

A unique identifier for the reserved cache node offering.

SecurityGroupMembership

data SecurityGroupMembership Source

Represents a single cache security group and its status.

See: securityGroupMembership smart constructor.

Instances

securityGroupMembership :: SecurityGroupMembership Source

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 :: Lens' SecurityGroupMembership (Maybe Text) Source

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) Source

The identifier of the cache security group.

Snapshot

data Snapshot Source

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

See: snapshot smart constructor.

Instances

snapshot :: Snapshot Source

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:

sEngineVersion :: Lens' Snapshot (Maybe Text) Source

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

sCacheNodeType :: Lens' Snapshot (Maybe Text) Source

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.

sCacheClusterCreateTime :: Lens' Snapshot (Maybe UTCTime) Source

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

sAutoMinorVersionUpgrade :: Lens' Snapshot (Maybe Bool) Source

This parameter is currently disabled.

sCacheParameterGroupName :: Lens' Snapshot (Maybe Text) Source

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

sVPCId :: Lens' Snapshot (Maybe Text) Source

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

sSnapshotStatus :: Lens' Snapshot (Maybe Text) Source

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

sSnapshotWindow :: Lens' Snapshot (Maybe Text) Source

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

sCacheClusterId :: Lens' Snapshot (Maybe Text) Source

The user-supplied identifier of the source cache cluster.

sEngine :: Lens' Snapshot (Maybe Text) Source

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

sPreferredMaintenanceWindow :: Lens' Snapshot (Maybe Text) Source

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) Source

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

sNodeSnapshots :: Lens' Snapshot [NodeSnapshot] Source

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

sCacheSubnetGroupName :: Lens' Snapshot (Maybe Text) Source

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

sPreferredAvailabilityZone :: Lens' Snapshot (Maybe Text) Source

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

sSnapshotRetentionLimit :: Lens' Snapshot (Maybe Int) Source

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) Source

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

sNumCacheNodes :: Lens' Snapshot (Maybe Int) Source

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) Source

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

sSnapshotSource :: Lens' Snapshot (Maybe Text) Source

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

Subnet

data Subnet Source

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

subnet :: Subnet Source

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 :: Lens' Subnet (Maybe Text) Source

The unique identifier for the subnet.

sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source

The Availability Zone associated with the subnet.

Tag

data Tag Source

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

tag :: Tag Source

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 :: Lens' Tag (Maybe Text) Source

The tag's value. May not be null.

tagKey :: Lens' Tag (Maybe Text) Source

The key for the tag.

TagListMessage

data TagListMessage Source

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

See: tagListMessage smart constructor.

Instances

tagListMessage :: TagListMessage Source

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 :: Lens' TagListMessage [Tag] Source

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