Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- CacheSubnetGroupInUse
- ReservedCacheNodeAlreadyExistsFault
- CacheSecurityGroupNotFoundFault
- CacheSubnetGroupAlreadyExistsFault
- NodeGroupsPerReplicationGroupQuotaExceededFault
- CacheSubnetGroupQuotaExceededFault
- AuthorizationAlreadyExistsFault
- ReservedCacheNodeQuotaExceededFault
- ReservedCacheNodesOfferingNotFoundFault
- ReplicationGroupNotFoundFault
- InvalidSubnet
- TagQuotaPerResourceExceeded
- SnapshotNotFoundFault
- InsufficientCacheClusterCapacityFault
- InvalidSnapshotStateFault
- SnapshotAlreadyExistsFault
- TagNotFoundFault
- SnapshotQuotaExceededFault
- NodeQuotaForClusterExceededFault
- APICallRateForCustomerExceededFault
- NodeGroupNotFoundFault
- CacheParameterGroupAlreadyExistsFault
- ReservedCacheNodeNotFoundFault
- CacheSubnetGroupNotFoundFault
- SnapshotFeatureNotSupportedFault
- InvalidParameterValueException
- TestFailoverNotAvailableFault
- InvalidReplicationGroupStateFault
- ReplicationGroupAlreadyExistsFault
- InvalidVPCNetworkStateFault
- SubnetInUse
- CacheClusterNotFoundFault
- ClusterQuotaForCustomerExceededFault
- AuthorizationNotFoundFault
- InvalidCacheClusterStateFault
- CacheSecurityGroupQuotaExceededFault
- CacheClusterAlreadyExistsFault
- CacheParameterGroupQuotaExceededFault
- NodeQuotaForCustomerExceededFault
- CacheSubnetQuotaExceededFault
- CacheParameterGroupNotFoundFault
- InvalidARNFault
- InvalidCacheParameterGroupStateFault
- InvalidParameterCombinationException
- InvalidCacheSecurityGroupStateFault
- CacheSecurityGroupAlreadyExistsFault
- Waiters
- Operations
- DeleteCacheSecurityGroup
- CreateReplicationGroup
- DeleteCacheCluster
- RebootCacheCluster
- RevokeCacheSecurityGroupIngress
- CreateCacheCluster
- DescribeEvents (Paginated)
- DescribeEngineDefaultParameters (Paginated)
- ModifyCacheParameterGroup
- TestFailover
- DeleteReplicationGroup
- ListTagsForResource
- DescribeCacheClusters (Paginated)
- PurchaseReservedCacheNodesOffering
- RemoveTagsFromResource
- ModifyReplicationGroup
- DescribeCacheParameters (Paginated)
- DescribeCacheSubnetGroups (Paginated)
- CreateCacheSecurityGroup
- AddTagsToResource
- AuthorizeCacheSecurityGroupIngress
- CopySnapshot
- CreateCacheSubnetGroup
- DescribeCacheParameterGroups (Paginated)
- ResetCacheParameterGroup
- ListAllowedNodeTypeModifications
- ModifyReplicationGroupShardConfiguration
- DescribeSnapshots (Paginated)
- DescribeReplicationGroups (Paginated)
- DeleteSnapshot
- DescribeReservedCacheNodesOfferings (Paginated)
- ModifyCacheSubnetGroup
- CreateSnapshot
- DeleteCacheParameterGroup
- DescribeCacheSecurityGroups (Paginated)
- ModifyCacheCluster
- DescribeCacheEngineVersions (Paginated)
- CreateCacheParameterGroup
- DescribeReservedCacheNodes (Paginated)
- DeleteCacheSubnetGroup
- Types
- AZMode
- AutomaticFailoverStatus
- ChangeType
- PendingAutomaticFailoverStatus
- SourceType
- AvailabilityZone
- CacheCluster
- CacheEngineVersion
- CacheNode
- CacheNodeTypeSpecificParameter
- CacheNodeTypeSpecificValue
- CacheParameterGroup
- CacheParameterGroupNameMessage
- CacheParameterGroupStatus
- CacheSecurityGroup
- CacheSecurityGroupMembership
- CacheSubnetGroup
- EC2SecurityGroup
- Endpoint
- EngineDefaults
- Event
- NodeGroup
- NodeGroupConfiguration
- NodeGroupMember
- NodeSnapshot
- NotificationConfiguration
- Parameter
- ParameterNameValue
- PendingModifiedValues
- RecurringCharge
- ReplicationGroup
- ReplicationGroupPendingModifiedValues
- ReservedCacheNode
- ReservedCacheNodesOffering
- ReshardingConfiguration
- ReshardingStatus
- SecurityGroupMembership
- SlotMigration
- Snapshot
- Subnet
- Tag
- TagListMessage
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 get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in 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.
- elastiCache :: Service
- _CacheSubnetGroupInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodeAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeGroupsPerReplicationGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodeQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicationGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError
- _TagQuotaPerResourceExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientCacheClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _TagNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeQuotaForClusterExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _APICallRateForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotFeatureNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _TestFailoverNotAvailableFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidReplicationGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicationGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCacheClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidARNFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCacheParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCacheSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- cacheClusterAvailable :: Wait DescribeCacheClusters
- cacheClusterDeleted :: Wait DescribeCacheClusters
- replicationGroupDeleted :: Wait DescribeReplicationGroups
- replicationGroupAvailable :: Wait DescribeReplicationGroups
- module Network.AWS.ElastiCache.DeleteCacheSecurityGroup
- module Network.AWS.ElastiCache.CreateReplicationGroup
- module Network.AWS.ElastiCache.DeleteCacheCluster
- module Network.AWS.ElastiCache.RebootCacheCluster
- module Network.AWS.ElastiCache.RevokeCacheSecurityGroupIngress
- module Network.AWS.ElastiCache.CreateCacheCluster
- module Network.AWS.ElastiCache.DescribeEvents
- module Network.AWS.ElastiCache.DescribeEngineDefaultParameters
- module Network.AWS.ElastiCache.ModifyCacheParameterGroup
- module Network.AWS.ElastiCache.TestFailover
- module Network.AWS.ElastiCache.DeleteReplicationGroup
- module Network.AWS.ElastiCache.ListTagsForResource
- module Network.AWS.ElastiCache.DescribeCacheClusters
- module Network.AWS.ElastiCache.PurchaseReservedCacheNodesOffering
- module Network.AWS.ElastiCache.RemoveTagsFromResource
- module Network.AWS.ElastiCache.ModifyReplicationGroup
- module Network.AWS.ElastiCache.DescribeCacheParameters
- module Network.AWS.ElastiCache.DescribeCacheSubnetGroups
- module Network.AWS.ElastiCache.CreateCacheSecurityGroup
- module Network.AWS.ElastiCache.AddTagsToResource
- module Network.AWS.ElastiCache.AuthorizeCacheSecurityGroupIngress
- module Network.AWS.ElastiCache.CopySnapshot
- module Network.AWS.ElastiCache.CreateCacheSubnetGroup
- module Network.AWS.ElastiCache.DescribeCacheParameterGroups
- module Network.AWS.ElastiCache.ResetCacheParameterGroup
- module Network.AWS.ElastiCache.ListAllowedNodeTypeModifications
- module Network.AWS.ElastiCache.ModifyReplicationGroupShardConfiguration
- module Network.AWS.ElastiCache.DescribeSnapshots
- module Network.AWS.ElastiCache.DescribeReplicationGroups
- module Network.AWS.ElastiCache.DeleteSnapshot
- module Network.AWS.ElastiCache.DescribeReservedCacheNodesOfferings
- module Network.AWS.ElastiCache.ModifyCacheSubnetGroup
- module Network.AWS.ElastiCache.CreateSnapshot
- module Network.AWS.ElastiCache.DeleteCacheParameterGroup
- module Network.AWS.ElastiCache.DescribeCacheSecurityGroups
- module Network.AWS.ElastiCache.ModifyCacheCluster
- module Network.AWS.ElastiCache.DescribeCacheEngineVersions
- module Network.AWS.ElastiCache.CreateCacheParameterGroup
- module Network.AWS.ElastiCache.DescribeReservedCacheNodes
- module Network.AWS.ElastiCache.DeleteCacheSubnetGroup
- data AZMode
- data AutomaticFailoverStatus
- data ChangeType
- data PendingAutomaticFailoverStatus
- data SourceType
- data AvailabilityZone
- availabilityZone :: AvailabilityZone
- azName :: Lens' AvailabilityZone (Maybe Text)
- data CacheCluster
- cacheCluster :: CacheCluster
- ccEngineVersion :: Lens' CacheCluster (Maybe Text)
- ccCacheNodeType :: Lens' CacheCluster (Maybe Text)
- ccCacheNodes :: Lens' CacheCluster [CacheNode]
- ccCacheClusterCreateTime :: Lens' CacheCluster (Maybe UTCTime)
- ccAtRestEncryptionEnabled :: Lens' CacheCluster (Maybe Bool)
- ccAutoMinorVersionUpgrade :: Lens' CacheCluster (Maybe Bool)
- ccSecurityGroups :: Lens' CacheCluster [SecurityGroupMembership]
- ccNotificationConfiguration :: Lens' CacheCluster (Maybe NotificationConfiguration)
- ccTransitEncryptionEnabled :: Lens' CacheCluster (Maybe Bool)
- ccSnapshotWindow :: Lens' CacheCluster (Maybe Text)
- ccCacheClusterId :: Lens' CacheCluster (Maybe Text)
- ccConfigurationEndpoint :: Lens' CacheCluster (Maybe Endpoint)
- ccEngine :: Lens' CacheCluster (Maybe Text)
- ccCacheSecurityGroups :: Lens' CacheCluster [CacheSecurityGroupMembership]
- ccAuthTokenEnabled :: Lens' CacheCluster (Maybe Bool)
- ccClientDownloadLandingPage :: Lens' CacheCluster (Maybe Text)
- ccPreferredMaintenanceWindow :: Lens' CacheCluster (Maybe Text)
- ccCacheSubnetGroupName :: Lens' CacheCluster (Maybe Text)
- ccPreferredAvailabilityZone :: Lens' CacheCluster (Maybe Text)
- ccCacheParameterGroup :: Lens' CacheCluster (Maybe CacheParameterGroupStatus)
- ccCacheClusterStatus :: Lens' CacheCluster (Maybe Text)
- ccSnapshotRetentionLimit :: Lens' CacheCluster (Maybe Int)
- ccReplicationGroupId :: Lens' CacheCluster (Maybe Text)
- ccPendingModifiedValues :: Lens' CacheCluster (Maybe PendingModifiedValues)
- ccNumCacheNodes :: Lens' CacheCluster (Maybe Int)
- data CacheEngineVersion
- cacheEngineVersion :: CacheEngineVersion
- cevEngineVersion :: Lens' CacheEngineVersion (Maybe Text)
- cevCacheParameterGroupFamily :: Lens' CacheEngineVersion (Maybe Text)
- cevCacheEngineDescription :: Lens' CacheEngineVersion (Maybe Text)
- cevEngine :: Lens' CacheEngineVersion (Maybe Text)
- cevCacheEngineVersionDescription :: Lens' CacheEngineVersion (Maybe Text)
- data CacheNode
- cacheNode :: CacheNode
- cnSourceCacheNodeId :: Lens' CacheNode (Maybe Text)
- cnParameterGroupStatus :: Lens' CacheNode (Maybe Text)
- cnCacheNodeCreateTime :: Lens' CacheNode (Maybe UTCTime)
- cnCustomerAvailabilityZone :: Lens' CacheNode (Maybe Text)
- cnCacheNodeId :: Lens' CacheNode (Maybe Text)
- cnCacheNodeStatus :: Lens' CacheNode (Maybe Text)
- cnEndpoint :: Lens' CacheNode (Maybe Endpoint)
- data CacheNodeTypeSpecificParameter
- cacheNodeTypeSpecificParameter :: CacheNodeTypeSpecificParameter
- cntspCacheNodeTypeSpecificValues :: Lens' CacheNodeTypeSpecificParameter [CacheNodeTypeSpecificValue]
- cntspMinimumEngineVersion :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)
- cntspSource :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)
- cntspIsModifiable :: Lens' CacheNodeTypeSpecificParameter (Maybe Bool)
- cntspDataType :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)
- cntspAllowedValues :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)
- cntspParameterName :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)
- cntspDescription :: Lens' CacheNodeTypeSpecificParameter (Maybe Text)
- cntspChangeType :: Lens' CacheNodeTypeSpecificParameter (Maybe ChangeType)
- data CacheNodeTypeSpecificValue
- cacheNodeTypeSpecificValue :: CacheNodeTypeSpecificValue
- cntsvCacheNodeType :: Lens' CacheNodeTypeSpecificValue (Maybe Text)
- cntsvValue :: Lens' CacheNodeTypeSpecificValue (Maybe Text)
- data CacheParameterGroup
- cacheParameterGroup :: CacheParameterGroup
- cpgCacheParameterGroupFamily :: Lens' CacheParameterGroup (Maybe Text)
- cpgCacheParameterGroupName :: Lens' CacheParameterGroup (Maybe Text)
- cpgDescription :: Lens' CacheParameterGroup (Maybe Text)
- data CacheParameterGroupNameMessage
- cacheParameterGroupNameMessage :: CacheParameterGroupNameMessage
- cpgnmCacheParameterGroupName :: Lens' CacheParameterGroupNameMessage (Maybe Text)
- data CacheParameterGroupStatus
- cacheParameterGroupStatus :: CacheParameterGroupStatus
- cpgsCacheParameterGroupName :: Lens' CacheParameterGroupStatus (Maybe Text)
- cpgsCacheNodeIdsToReboot :: Lens' CacheParameterGroupStatus [Text]
- cpgsParameterApplyStatus :: Lens' CacheParameterGroupStatus (Maybe Text)
- data CacheSecurityGroup
- cacheSecurityGroup :: CacheSecurityGroup
- csgCacheSecurityGroupName :: Lens' CacheSecurityGroup (Maybe Text)
- csgOwnerId :: Lens' CacheSecurityGroup (Maybe Text)
- csgEC2SecurityGroups :: Lens' CacheSecurityGroup [EC2SecurityGroup]
- csgDescription :: Lens' CacheSecurityGroup (Maybe Text)
- data CacheSecurityGroupMembership
- cacheSecurityGroupMembership :: CacheSecurityGroupMembership
- csgmStatus :: Lens' CacheSecurityGroupMembership (Maybe Text)
- csgmCacheSecurityGroupName :: Lens' CacheSecurityGroupMembership (Maybe Text)
- data CacheSubnetGroup
- cacheSubnetGroup :: CacheSubnetGroup
- csgVPCId :: Lens' CacheSubnetGroup (Maybe Text)
- csgSubnets :: Lens' CacheSubnetGroup [Subnet]
- csgCacheSubnetGroupName :: Lens' CacheSubnetGroup (Maybe Text)
- csgCacheSubnetGroupDescription :: Lens' CacheSubnetGroup (Maybe Text)
- data EC2SecurityGroup
- ec2SecurityGroup :: EC2SecurityGroup
- esgStatus :: Lens' EC2SecurityGroup (Maybe Text)
- esgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text)
- esgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text)
- data Endpoint
- endpoint :: Endpoint
- eAddress :: Lens' Endpoint (Maybe Text)
- ePort :: Lens' Endpoint (Maybe Int)
- data EngineDefaults
- engineDefaults :: EngineDefaults
- edCacheParameterGroupFamily :: Lens' EngineDefaults (Maybe Text)
- edCacheNodeTypeSpecificParameters :: Lens' EngineDefaults [CacheNodeTypeSpecificParameter]
- edMarker :: Lens' EngineDefaults (Maybe Text)
- edParameters :: Lens' EngineDefaults [Parameter]
- data Event
- event :: Event
- eSourceType :: Lens' Event (Maybe SourceType)
- eSourceIdentifier :: Lens' Event (Maybe Text)
- eDate :: Lens' Event (Maybe UTCTime)
- eMessage :: Lens' Event (Maybe Text)
- data NodeGroup
- nodeGroup :: NodeGroup
- ngStatus :: Lens' NodeGroup (Maybe Text)
- ngPrimaryEndpoint :: Lens' NodeGroup (Maybe Endpoint)
- ngSlots :: Lens' NodeGroup (Maybe Text)
- ngNodeGroupMembers :: Lens' NodeGroup [NodeGroupMember]
- ngNodeGroupId :: Lens' NodeGroup (Maybe Text)
- data NodeGroupConfiguration
- nodeGroupConfiguration :: NodeGroupConfiguration
- ngcSlots :: Lens' NodeGroupConfiguration (Maybe Text)
- ngcReplicaCount :: Lens' NodeGroupConfiguration (Maybe Int)
- ngcPrimaryAvailabilityZone :: Lens' NodeGroupConfiguration (Maybe Text)
- ngcReplicaAvailabilityZones :: Lens' NodeGroupConfiguration [Text]
- data NodeGroupMember
- nodeGroupMember :: NodeGroupMember
- ngmCacheClusterId :: Lens' NodeGroupMember (Maybe Text)
- ngmCacheNodeId :: Lens' NodeGroupMember (Maybe Text)
- ngmPreferredAvailabilityZone :: Lens' NodeGroupMember (Maybe Text)
- ngmCurrentRole :: Lens' NodeGroupMember (Maybe Text)
- ngmReadEndpoint :: Lens' NodeGroupMember (Maybe Endpoint)
- data NodeSnapshot
- nodeSnapshot :: NodeSnapshot
- nsNodeGroupConfiguration :: Lens' NodeSnapshot (Maybe NodeGroupConfiguration)
- nsCacheNodeCreateTime :: Lens' NodeSnapshot (Maybe UTCTime)
- nsCacheClusterId :: Lens' NodeSnapshot (Maybe Text)
- nsCacheNodeId :: Lens' NodeSnapshot (Maybe Text)
- nsNodeGroupId :: Lens' NodeSnapshot (Maybe Text)
- nsSnapshotCreateTime :: Lens' NodeSnapshot (Maybe UTCTime)
- nsCacheSize :: Lens' NodeSnapshot (Maybe Text)
- data NotificationConfiguration
- notificationConfiguration :: NotificationConfiguration
- ncTopicStatus :: Lens' NotificationConfiguration (Maybe Text)
- ncTopicARN :: Lens' NotificationConfiguration (Maybe Text)
- data Parameter
- parameter :: Parameter
- pParameterValue :: Lens' Parameter (Maybe Text)
- pMinimumEngineVersion :: Lens' Parameter (Maybe Text)
- pSource :: Lens' Parameter (Maybe Text)
- pIsModifiable :: Lens' Parameter (Maybe Bool)
- pDataType :: Lens' Parameter (Maybe Text)
- pAllowedValues :: Lens' Parameter (Maybe Text)
- pParameterName :: Lens' Parameter (Maybe Text)
- pDescription :: Lens' Parameter (Maybe Text)
- pChangeType :: Lens' Parameter (Maybe ChangeType)
- data ParameterNameValue
- parameterNameValue :: ParameterNameValue
- pnvParameterValue :: Lens' ParameterNameValue (Maybe Text)
- pnvParameterName :: Lens' ParameterNameValue (Maybe Text)
- data PendingModifiedValues
- pendingModifiedValues :: PendingModifiedValues
- pmvEngineVersion :: Lens' PendingModifiedValues (Maybe Text)
- pmvCacheNodeType :: Lens' PendingModifiedValues (Maybe Text)
- pmvCacheNodeIdsToRemove :: Lens' PendingModifiedValues [Text]
- pmvNumCacheNodes :: Lens' PendingModifiedValues (Maybe Int)
- data RecurringCharge
- recurringCharge :: RecurringCharge
- rcRecurringChargeFrequency :: Lens' RecurringCharge (Maybe Text)
- rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double)
- data ReplicationGroup
- replicationGroup :: ReplicationGroup
- rgStatus :: Lens' ReplicationGroup (Maybe Text)
- rgCacheNodeType :: Lens' ReplicationGroup (Maybe Text)
- rgNodeGroups :: Lens' ReplicationGroup [NodeGroup]
- rgSnapshottingClusterId :: Lens' ReplicationGroup (Maybe Text)
- rgClusterEnabled :: Lens' ReplicationGroup (Maybe Bool)
- rgAtRestEncryptionEnabled :: Lens' ReplicationGroup (Maybe Bool)
- rgTransitEncryptionEnabled :: Lens' ReplicationGroup (Maybe Bool)
- rgSnapshotWindow :: Lens' ReplicationGroup (Maybe Text)
- rgConfigurationEndpoint :: Lens' ReplicationGroup (Maybe Endpoint)
- rgAuthTokenEnabled :: Lens' ReplicationGroup (Maybe Bool)
- rgMemberClusters :: Lens' ReplicationGroup [Text]
- rgSnapshotRetentionLimit :: Lens' ReplicationGroup (Maybe Int)
- rgDescription :: Lens' ReplicationGroup (Maybe Text)
- rgReplicationGroupId :: Lens' ReplicationGroup (Maybe Text)
- rgPendingModifiedValues :: Lens' ReplicationGroup (Maybe ReplicationGroupPendingModifiedValues)
- rgAutomaticFailover :: Lens' ReplicationGroup (Maybe AutomaticFailoverStatus)
- data ReplicationGroupPendingModifiedValues
- replicationGroupPendingModifiedValues :: ReplicationGroupPendingModifiedValues
- rgpmvResharding :: Lens' ReplicationGroupPendingModifiedValues (Maybe ReshardingStatus)
- rgpmvPrimaryClusterId :: Lens' ReplicationGroupPendingModifiedValues (Maybe Text)
- rgpmvAutomaticFailoverStatus :: Lens' ReplicationGroupPendingModifiedValues (Maybe PendingAutomaticFailoverStatus)
- data ReservedCacheNode
- reservedCacheNode :: ReservedCacheNode
- rcnCacheNodeType :: Lens' ReservedCacheNode (Maybe Text)
- rcnState :: Lens' ReservedCacheNode (Maybe Text)
- rcnStartTime :: Lens' ReservedCacheNode (Maybe UTCTime)
- rcnProductDescription :: Lens' ReservedCacheNode (Maybe Text)
- rcnCacheNodeCount :: Lens' ReservedCacheNode (Maybe Int)
- rcnReservedCacheNodeId :: Lens' ReservedCacheNode (Maybe Text)
- rcnRecurringCharges :: Lens' ReservedCacheNode [RecurringCharge]
- rcnOfferingType :: Lens' ReservedCacheNode (Maybe Text)
- rcnUsagePrice :: Lens' ReservedCacheNode (Maybe Double)
- rcnFixedPrice :: Lens' ReservedCacheNode (Maybe Double)
- rcnDuration :: Lens' ReservedCacheNode (Maybe Int)
- rcnReservedCacheNodesOfferingId :: Lens' ReservedCacheNode (Maybe Text)
- data ReservedCacheNodesOffering
- reservedCacheNodesOffering :: ReservedCacheNodesOffering
- rcnoCacheNodeType :: Lens' ReservedCacheNodesOffering (Maybe Text)
- rcnoProductDescription :: Lens' ReservedCacheNodesOffering (Maybe Text)
- rcnoRecurringCharges :: Lens' ReservedCacheNodesOffering [RecurringCharge]
- rcnoOfferingType :: Lens' ReservedCacheNodesOffering (Maybe Text)
- rcnoUsagePrice :: Lens' ReservedCacheNodesOffering (Maybe Double)
- rcnoFixedPrice :: Lens' ReservedCacheNodesOffering (Maybe Double)
- rcnoDuration :: Lens' ReservedCacheNodesOffering (Maybe Int)
- rcnoReservedCacheNodesOfferingId :: Lens' ReservedCacheNodesOffering (Maybe Text)
- data ReshardingConfiguration
- reshardingConfiguration :: ReshardingConfiguration
- rcPreferredAvailabilityZones :: Lens' ReshardingConfiguration [Text]
- data ReshardingStatus
- reshardingStatus :: ReshardingStatus
- rsSlotMigration :: Lens' ReshardingStatus (Maybe SlotMigration)
- data SecurityGroupMembership
- securityGroupMembership :: SecurityGroupMembership
- sgmStatus :: Lens' SecurityGroupMembership (Maybe Text)
- sgmSecurityGroupId :: Lens' SecurityGroupMembership (Maybe Text)
- data SlotMigration
- slotMigration :: SlotMigration
- smProgressPercentage :: Lens' SlotMigration (Maybe Double)
- data Snapshot
- snapshot :: Snapshot
- sEngineVersion :: Lens' Snapshot (Maybe Text)
- sCacheNodeType :: Lens' Snapshot (Maybe Text)
- sCacheClusterCreateTime :: Lens' Snapshot (Maybe UTCTime)
- sAutoMinorVersionUpgrade :: Lens' Snapshot (Maybe Bool)
- sCacheParameterGroupName :: Lens' Snapshot (Maybe Text)
- sReplicationGroupDescription :: Lens' Snapshot (Maybe Text)
- sVPCId :: Lens' Snapshot (Maybe Text)
- sSnapshotStatus :: Lens' Snapshot (Maybe Text)
- sSnapshotWindow :: Lens' Snapshot (Maybe Text)
- sCacheClusterId :: Lens' Snapshot (Maybe Text)
- sEngine :: Lens' Snapshot (Maybe Text)
- sPreferredMaintenanceWindow :: Lens' Snapshot (Maybe Text)
- sTopicARN :: Lens' Snapshot (Maybe Text)
- sNodeSnapshots :: Lens' Snapshot [NodeSnapshot]
- sCacheSubnetGroupName :: Lens' Snapshot (Maybe Text)
- sPreferredAvailabilityZone :: Lens' Snapshot (Maybe Text)
- sNumNodeGroups :: Lens' Snapshot (Maybe Int)
- sSnapshotRetentionLimit :: Lens' Snapshot (Maybe Int)
- sSnapshotName :: Lens' Snapshot (Maybe Text)
- sReplicationGroupId :: Lens' Snapshot (Maybe Text)
- sNumCacheNodes :: Lens' Snapshot (Maybe Int)
- sPort :: Lens' Snapshot (Maybe Int)
- sAutomaticFailover :: Lens' Snapshot (Maybe AutomaticFailoverStatus)
- sSnapshotSource :: Lens' Snapshot (Maybe Text)
- data Subnet
- subnet :: Subnet
- sSubnetIdentifier :: Lens' Subnet (Maybe Text)
- sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
- data TagListMessage
- tagListMessage :: TagListMessage
- tlmTagList :: Lens' TagListMessage [Tag]
Service Configuration
elastiCache :: Service Source #
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
.
CacheSubnetGroupInUse
_CacheSubnetGroupInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache subnet group is currently in use.
ReservedCacheNodeAlreadyExistsFault
_ReservedCacheNodeAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a reservation with the given identifier.
CacheSecurityGroupNotFoundFault
_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
_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.
NodeGroupsPerReplicationGroupQuotaExceededFault
_NodeGroupsPerReplicationGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 15
CacheSubnetGroupQuotaExceededFault
_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
_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
_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
_ReservedCacheNodesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache node offering does not exist.
ReplicationGroupNotFoundFault
_ReplicationGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified replication group does not exist.
InvalidSubnet
_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #
An invalid subnet identifier was specified.
TagQuotaPerResourceExceeded
_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 50.
SnapshotNotFoundFault
_SnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested snapshot name does not refer to an existing snapshot.
InsufficientCacheClusterCapacityFault
_InsufficientCacheClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache node type is not available in the specified Availability Zone.
InvalidSnapshotStateFault
_InvalidSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The current state of the snapshot does not allow the requested operation to occur.
SnapshotAlreadyExistsFault
_SnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a snapshot with the given name.
TagNotFoundFault
_TagNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested tag was not found on this resource.
SnapshotQuotaExceededFault
_SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the maximum number of snapshots.
NodeQuotaForClusterExceededFault
_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 cluster.
APICallRateForCustomerExceededFault
_APICallRateForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The customer has exceeded the allowed rate of API calls.
NodeGroupNotFoundFault
_NodeGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The node group specified by the NodeGroupId
parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId
value correctly.
CacheParameterGroupAlreadyExistsFault
_CacheParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A cache parameter group with the requested name already exists.
ReservedCacheNodeNotFoundFault
_ReservedCacheNodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested reserved cache node was not found.
CacheSubnetGroupNotFoundFault
_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
_SnapshotFeatureNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You attempted one of the following operations:
- Creating a snapshot of a Redis cluster running on a
cache.t1.micro
cache node. - Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value for a parameter is invalid.
TestFailoverNotAvailableFault
_TestFailoverNotAvailableFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for TestFailoverNotAvailableFault' errors.
InvalidReplicationGroupStateFault
_InvalidReplicationGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested replication group is not in the available
state.
ReplicationGroupAlreadyExistsFault
_ReplicationGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified replication group already exists.
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC network is in an invalid state.
SubnetInUse
_SubnetInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested subnet is being used by another cache subnet group.
CacheClusterNotFoundFault
_CacheClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cluster ID does not refer to an existing cluster.
ClusterQuotaForCustomerExceededFault
_ClusterQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of clusters per customer.
AuthorizationNotFoundFault
_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
_InvalidCacheClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cluster is not in the available
state.
CacheSecurityGroupQuotaExceededFault
_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
_CacheClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a cluster with the given identifier.
CacheParameterGroupQuotaExceededFault
_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
_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
_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
_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
_InvalidARNFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidCacheParameterGroupStateFault
_InvalidCacheParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The current state of the cache parameter group does not allow the requested operation to occur.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Two or more incompatible parameters were specified.
InvalidCacheSecurityGroupStateFault
_InvalidCacheSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The current state of the cache security group does not allow deletion.
CacheSecurityGroupAlreadyExistsFault
_CacheSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A cache security group with the specified name already exists.
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 Source #
Polls DescribeCacheClusters
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
CacheClusterDeleted
cacheClusterDeleted :: Wait DescribeCacheClusters Source #
Polls DescribeCacheClusters
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
ReplicationGroupDeleted
replicationGroupDeleted :: Wait DescribeReplicationGroups Source #
Polls DescribeReplicationGroups
every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
ReplicationGroupAvailable
replicationGroupAvailable :: Wait DescribeReplicationGroups Source #
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
CreateReplicationGroup
DeleteCacheCluster
RebootCacheCluster
RevokeCacheSecurityGroupIngress
CreateCacheCluster
DescribeEvents (Paginated)
DescribeEngineDefaultParameters (Paginated)
ModifyCacheParameterGroup
TestFailover
DeleteReplicationGroup
ListTagsForResource
DescribeCacheClusters (Paginated)
PurchaseReservedCacheNodesOffering
RemoveTagsFromResource
ModifyReplicationGroup
DescribeCacheParameters (Paginated)
DescribeCacheSubnetGroups (Paginated)
CreateCacheSecurityGroup
AddTagsToResource
AuthorizeCacheSecurityGroupIngress
CopySnapshot
CreateCacheSubnetGroup
DescribeCacheParameterGroups (Paginated)
ResetCacheParameterGroup
ListAllowedNodeTypeModifications
ModifyReplicationGroupShardConfiguration
DescribeSnapshots (Paginated)
DescribeReplicationGroups (Paginated)
DeleteSnapshot
DescribeReservedCacheNodesOfferings (Paginated)
ModifyCacheSubnetGroup
CreateSnapshot
DeleteCacheParameterGroup
DescribeCacheSecurityGroups (Paginated)
ModifyCacheCluster
DescribeCacheEngineVersions (Paginated)
CreateCacheParameterGroup
DescribeReservedCacheNodes (Paginated)
DeleteCacheSubnetGroup
Types
AZMode
AutomaticFailoverStatus
data AutomaticFailoverStatus Source #
ChangeType
data ChangeType Source #
PendingAutomaticFailoverStatus
data PendingAutomaticFailoverStatus Source #
SourceType
data SourceType Source #
AvailabilityZone
data AvailabilityZone Source #
Describes an Availability Zone in which the cluster is launched.
See: availabilityZone
smart constructor.
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
- The name of the Availability Zone.
CacheCluster
data CacheCluster Source #
Contains all of the attributes of a specific cluster.
See: cacheCluster
smart constructor.
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
- The version of the cache engine that is used in this cluster.ccCacheNodeType
- The name of the compute and memory capacity node type for the cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types:cache.t2.micro
,cache.t2.small
,cache.t2.medium
M3 node types:cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
M4 node types:cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types:cache.t1.micro
M1 node types:cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types:cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types:cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types:cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .ccCacheNodes
- A list of cache nodes that are members of the cluster.ccCacheClusterCreateTime
- The date and time when the cluster was created.ccAtRestEncryptionEnabled
- A flag that enables encryption at-rest when set totrue
. You cannot modify the value ofAtRestEncryptionEnabled
after the cluster is created. To enable at-rest encryption on a cluster you must setAtRestEncryptionEnabled
totrue
when you create a cluster. Default:false
ccAutoMinorVersionUpgrade
- This parameter is currently disabled.ccSecurityGroups
- A list of VPC Security Groups associated with the cluster.ccNotificationConfiguration
- Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).ccTransitEncryptionEnabled
- A flag that enables in-transit encryption when set totrue
. You cannot modify the value ofTransitEncryptionEnabled
after the cluster is created. To enable in-transit encryption on a cluster you must setTransitEncryptionEnabled
totrue
when you create a cluster. Default:false
ccSnapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example:05:00-09:00
ccCacheClusterId
- The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.ccConfigurationEndpoint
- Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have.cfg
in it. Example:mem-3.9dvc4r.cfg .usw2.cache.amazonaws.com:11211
ccEngine
- The name of the cache engine (memcached
orredis
) to be used for this cluster.ccCacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.ccAuthTokenEnabled
- A flag that enables using anAuthToken
(password) when issuing Redis commands. Default:false
ccClientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache client library.ccPreferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values forddd
are: *sun
*mon
*tue
*wed
*thu
*fri
*sat
Example:sun:23:00-mon:01:30
ccCacheSubnetGroupName
- The name of the cache subnet group associated with the cluster.ccPreferredAvailabilityZone
- The name of the Availability Zone in which the cluster is located or Multiple if the cache nodes are located in different Availability Zones.ccCacheParameterGroup
- Status of the cache parameter group.ccCacheClusterStatus
- The current state of this cluster, one of the following values:available
,creating
,deleted
,deleting
,incompatible-network
,modifying
,rebooting cluster nodes
,restore-failed
, orsnapshotting
.ccSnapshotRetentionLimit
- The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you setSnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted. Important: If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.ccReplicationGroupId
- The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.ccPendingModifiedValues
- Undocumented member.ccNumCacheNodes
- The number of cache nodes in the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
ccEngineVersion :: Lens' CacheCluster (Maybe Text) Source #
The version of the cache engine that is used in this cluster.
ccCacheNodeType :: Lens' CacheCluster (Maybe Text) Source #
The name of the compute and memory capacity node type for the cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types: cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either 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 cluster.
ccCacheClusterCreateTime :: Lens' CacheCluster (Maybe UTCTime) Source #
The date and time when the cluster was created.
ccAtRestEncryptionEnabled :: Lens' CacheCluster (Maybe Bool) Source #
A flag that enables encryption at-rest when set to true
. You cannot modify the value of AtRestEncryptionEnabled
after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled
to true
when you create a cluster. Default: false
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 cluster.
ccNotificationConfiguration :: Lens' CacheCluster (Maybe 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).
ccTransitEncryptionEnabled :: Lens' CacheCluster (Maybe Bool) Source #
A flag that enables in-transit encryption when set to true
. You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
to true
when you create a cluster. Default: false
ccSnapshotWindow :: Lens' CacheCluster (Maybe Text) Source #
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00
ccCacheClusterId :: Lens' CacheCluster (Maybe Text) Source #
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
ccConfigurationEndpoint :: Lens' CacheCluster (Maybe Endpoint) Source #
Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg
in it. Example: mem-3.9dvc4r.cfg .usw2.cache.amazonaws.com:11211
ccEngine :: Lens' CacheCluster (Maybe Text) Source #
The name of the cache engine (memcached
or redis
) to be used for this cluster.
ccCacheSecurityGroups :: Lens' CacheCluster [CacheSecurityGroupMembership] Source #
A list of cache security group elements, composed of name and status sub-elements.
ccAuthTokenEnabled :: Lens' CacheCluster (Maybe Bool) Source #
A flag that enables using an AuthToken
(password) when issuing Redis commands. Default: false
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 cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd
are: * sun
* mon
* tue
* wed
* thu
* fri
* sat
Example: sun:23:00-mon:01:30
ccCacheSubnetGroupName :: Lens' CacheCluster (Maybe Text) Source #
The name of the cache subnet group associated with the cluster.
ccPreferredAvailabilityZone :: Lens' CacheCluster (Maybe Text) Source #
The name of the Availability Zone in which the cluster is located or Multiple if the cache nodes are located in different Availability Zones.
ccCacheParameterGroup :: Lens' CacheCluster (Maybe CacheParameterGroupStatus) Source #
Status of the cache parameter group.
ccCacheClusterStatus :: Lens' CacheCluster (Maybe Text) Source #
The current state of this cluster, one of the following values: available
, creating
, deleted
, deleting
, incompatible-network
, modifying
, rebooting cluster nodes
, restore-failed
, or snapshotting
.
ccSnapshotRetentionLimit :: Lens' CacheCluster (Maybe Int) Source #
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted. 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 cluster belongs. If this field is empty, the 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 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.
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
- The version number of the cache engine.cevCacheParameterGroupFamily
- The name of the cache parameter group family associated with this cache engine. Valid values are:memcached1.4
|redis2.6
|redis2.8
|redis3.2
cevCacheEngineDescription
- The description of the cache engine.cevEngine
- The name of the cache engine.cevCacheEngineVersionDescription
- The description of the cache engine version.
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. Valid values are: memcached1.4
| redis2.6
| redis2.8
| redis3.2
cevCacheEngineDescription :: Lens' CacheEngineVersion (Maybe Text) Source #
The description of the cache engine.
cevCacheEngineVersionDescription :: Lens' CacheEngineVersion (Maybe Text) Source #
The description of the cache engine version.
CacheNode
Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
- General purpose:
- Current generation:
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
- Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
- Compute optimized:
- Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
- Memory optimized:
- Current generation:
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
- Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
- All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
- Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
- Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
- Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .
See: cacheNode
smart constructor.
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
- The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.cnParameterGroupStatus
- The status of the parameter group applied to this cache node.cnCacheNodeCreateTime
- The date and time when the cache node was created.cnCustomerAvailabilityZone
- The Availability Zone where this node was created and now resides.cnCacheNodeId
- 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
- The current state of this cache node.cnEndpoint
- The hostname for connecting to this cache node.
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, this node is not associated with a primary 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.
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 cluster, a cache.m1.large
cache node type would have a larger maxmemory
value than a cache.m1.small
type.
See: cacheNodeTypeSpecificParameter
smart constructor.
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
- A list of cache node types and their corresponding values for this parameter.cntspMinimumEngineVersion
- The earliest cache engine version to which the parameter can apply.cntspSource
- The source of the parameter value.cntspIsModifiable
- 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
- The valid data type for the parameter.cntspAllowedValues
- The valid range of values for the parameter.cntspParameterName
- The name of the parameter.cntspDescription
- A description of the parameter.cntspChangeType
- Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster .
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.
cntspChangeType :: Lens' CacheNodeTypeSpecificParameter (Maybe ChangeType) Source #
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster .
CacheNodeTypeSpecificValue
data CacheNodeTypeSpecificValue Source #
A value that applies only to a certain cache node type.
See: cacheNodeTypeSpecificValue
smart constructor.
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
- The cache node type for which this value applies.cntsvValue
- The value for the cache node type.
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
operation.
See: cacheParameterGroup
smart constructor.
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
- The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are:memcached1.4
|redis2.6
|redis2.8
|redis3.2
cpgCacheParameterGroupName
- The name of the cache parameter group.cpgDescription
- The description for this cache parameter group.
cpgCacheParameterGroupFamily :: Lens' CacheParameterGroup (Maybe Text) Source #
The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are: memcached1.4
| redis2.6
| redis2.8
| redis3.2
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 operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
See: cacheParameterGroupNameMessage
smart constructor.
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
- The name of the cache parameter group.
cpgnmCacheParameterGroupName :: Lens' CacheParameterGroupNameMessage (Maybe Text) Source #
The name of the cache parameter group.
CacheParameterGroupStatus
data CacheParameterGroupStatus Source #
Status of the cache parameter group.
See: cacheParameterGroupStatus
smart constructor.
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
- The name of the cache parameter group.cpgsCacheNodeIdsToReboot
- 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
- The status of parameter updates.
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 operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
See: cacheSecurityGroup
smart constructor.
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
- The name of the cache security group.csgOwnerId
- The AWS account ID of the cache security group owner.csgEC2SecurityGroups
- A list of Amazon EC2 security groups that are associated with this cache security group.csgDescription
- The description of the cache security group.
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 cluster's status within a particular cache security group.
See: cacheSecurityGroupMembership
smart constructor.
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
- 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 cluster are modified.csgmCacheSecurityGroupName
- The name of the cache security group.
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 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 operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
See: cacheSubnetGroup
smart constructor.
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
- The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.csgSubnets
- A list of subnets associated with the cache subnet group.csgCacheSubnetGroupName
- The name of the cache subnet group.csgCacheSubnetGroupDescription
- The description of the cache subnet group.
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.
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
- The status of the Amazon EC2 security group.esgEC2SecurityGroupOwnerId
- The AWS account ID of the Amazon EC2 security group owner.esgEC2SecurityGroupName
- The name of the Amazon EC2 security group.
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
Represents the information required for client programs to connect to a cache node.
See: endpoint
smart constructor.
EngineDefaults
data EngineDefaults Source #
Represents the output of a DescribeEngineDefaultParameters
operation.
See: engineDefaults
smart constructor.
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
- Specifies the name of the cache parameter group family to which the engine default parameters apply. Valid values are:memcached1.4
|redis2.6
|redis2.8
|redis3.2
edCacheNodeTypeSpecificParameters
- A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.edMarker
- Provides an identifier to allow retrieval of paginated results.edParameters
- Contains a list of engine default parameters.
edCacheParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) Source #
Specifies the name of the cache parameter group family to which the engine default parameters apply. Valid values are: memcached1.4
| redis2.6
| redis2.8
| redis3.2
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
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
See: event
smart constructor.
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
- Specifies the origin of this event - a cluster, a parameter group, a security group, etc.eSourceIdentifier
- The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.eDate
- The date and time when the event occurred.eMessage
- The text of the event.
eSourceType :: Lens' Event (Maybe SourceType) Source #
Specifies the origin of this event - a 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 cluster level, the identifier would be the name of the cluster.
NodeGroup
Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
See: nodeGroup
smart constructor.
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
- The current state of this replication group -creating
,available
, etc.ngPrimaryEndpoint
- The endpoint of the primary node in this node group (shard).ngSlots
- The keyspace for this node group (shard).ngNodeGroupMembers
- A list containing information about individual nodes within the node group (shard).ngNodeGroupId
- The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
ngStatus :: Lens' NodeGroup (Maybe Text) Source #
The current state of this replication group - creating
, available
, etc.
ngPrimaryEndpoint :: Lens' NodeGroup (Maybe Endpoint) Source #
The endpoint of the primary node in this node group (shard).
ngNodeGroupMembers :: Lens' NodeGroup [NodeGroupMember] Source #
A list containing information about individual nodes within the node group (shard).
ngNodeGroupId :: Lens' NodeGroup (Maybe Text) Source #
The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
NodeGroupConfiguration
data NodeGroupConfiguration Source #
Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots
, PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
.
See: nodeGroupConfiguration
smart constructor.
nodeGroupConfiguration :: NodeGroupConfiguration Source #
Creates a value of NodeGroupConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ngcSlots
- A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the formatstartkey-endkey
. Example:"0-3999"
ngcReplicaCount
- The number of read replica nodes in this node group (shard).ngcPrimaryAvailabilityZone
- The Availability Zone where the primary node of this node group (shard) is launched.ngcReplicaAvailabilityZones
- A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value ofReplicaCount
orReplicasPerNodeGroup
if not specified.
ngcSlots :: Lens' NodeGroupConfiguration (Maybe Text) Source #
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey
. Example: "0-3999"
ngcReplicaCount :: Lens' NodeGroupConfiguration (Maybe Int) Source #
The number of read replica nodes in this node group (shard).
ngcPrimaryAvailabilityZone :: Lens' NodeGroupConfiguration (Maybe Text) Source #
The Availability Zone where the primary node of this node group (shard) is launched.
ngcReplicaAvailabilityZones :: Lens' NodeGroupConfiguration [Text] Source #
A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount
or ReplicasPerNodeGroup
if not specified.
NodeGroupMember
data NodeGroupMember Source #
Represents a single node within a node group (shard).
See: nodeGroupMember
smart constructor.
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
- The ID of the cluster to which the node belongs.ngmCacheNodeId
- The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).ngmPreferredAvailabilityZone
- The name of the Availability Zone in which the node is located.ngmCurrentRole
- The role that is currently assigned to the node -primary
orreplica
.ngmReadEndpoint
- Undocumented member.
ngmCacheClusterId :: Lens' NodeGroupMember (Maybe Text) Source #
The ID of the cluster to which the node belongs.
ngmCacheNodeId :: Lens' NodeGroupMember (Maybe Text) Source #
The ID of the node within its 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 cluster.
See: nodeSnapshot
smart constructor.
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:
nsNodeGroupConfiguration
- The configuration for the source node group (shard).nsCacheNodeCreateTime
- The date and time when the cache node was created in the source cluster.nsCacheClusterId
- A unique identifier for the source cluster.nsCacheNodeId
- The cache node identifier for the node in the source cluster.nsNodeGroupId
- A unique identifier for the source node group (shard).nsSnapshotCreateTime
- The date and time when the source node's metadata and cache data set was obtained for the snapshot.nsCacheSize
- The size of the cache on the source cache node.
nsNodeGroupConfiguration :: Lens' NodeSnapshot (Maybe NodeGroupConfiguration) Source #
The configuration for the source node group (shard).
nsCacheNodeCreateTime :: Lens' NodeSnapshot (Maybe UTCTime) Source #
The date and time when the cache node was created in the source cluster.
nsCacheClusterId :: Lens' NodeSnapshot (Maybe Text) Source #
A unique identifier for the source cluster.
nsCacheNodeId :: Lens' NodeSnapshot (Maybe Text) Source #
The cache node identifier for the node in the source cluster.
nsNodeGroupId :: Lens' NodeSnapshot (Maybe Text) Source #
A unique identifier for the source node group (shard).
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.
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
- The current state of the topic.ncTopicARN
- The Amazon Resource Name (ARN) that identifies the topic.
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
Describes an individual setting that controls some aspect of ElastiCache behavior.
See: parameter
smart constructor.
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
- The value of the parameter.pMinimumEngineVersion
- The earliest cache engine version to which the parameter can apply.pSource
- The source of the parameter.pIsModifiable
- 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
- The valid data type for the parameter.pAllowedValues
- The valid range of values for the parameter.pParameterName
- The name of the parameter.pDescription
- A description of the parameter.pChangeType
- Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster .
pMinimumEngineVersion :: Lens' Parameter (Maybe Text) Source #
The earliest cache engine version to which the parameter can apply.
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.
pChangeType :: Lens' Parameter (Maybe ChangeType) Source #
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster .
ParameterNameValue
data ParameterNameValue Source #
Describes a name-value pair that is used to update the value of a parameter.
See: parameterNameValue
smart constructor.
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
- The value of the parameter.pnvParameterName
- The name of the parameter.
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 are applied to the cluster in the future, or that are currently being applied.
See: pendingModifiedValues
smart constructor.
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
- The new cache engine version that the cluster runs.pmvCacheNodeType
- The cache node type that this cluster or replication group is scaled to.pmvCacheNodeIdsToRemove
- A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a numeric identifier (0001, 0002, etc.).pmvNumCacheNodes
- The new number of cache nodes for the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
pmvEngineVersion :: Lens' PendingModifiedValues (Maybe Text) Source #
The new cache engine version that the cluster runs.
pmvCacheNodeType :: Lens' PendingModifiedValues (Maybe Text) Source #
The cache node type that this cluster or replication group is scaled to.
pmvCacheNodeIdsToRemove :: Lens' PendingModifiedValues [Text] Source #
A list of cache node IDs that are being removed (or will be removed) from the 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 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.
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
- The frequency of the recurring charge.rcRecurringChargeAmount
- The monetary amount of the recurring charge.
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 Redis replication group.
See: replicationGroup
smart constructor.
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
- The current state of this replication group -creating
,available
,modifying
,deleting
,create-failed
,snapshotting
.rgCacheNodeType
- The name of the compute and memory capacity node type for each node in the replication group.rgNodeGroups
- A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).rgSnapshottingClusterId
- The cluster ID that is used as the daily snapshot source for the replication group.rgClusterEnabled
- A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). Valid values:true
|false
rgAtRestEncryptionEnabled
- A flag that enables encryption at-rest when set totrue
. You cannot modify the value ofAtRestEncryptionEnabled
after the cluster is created. To enable encryption at-rest on a cluster you must setAtRestEncryptionEnabled
totrue
when you create a cluster. Default:false
rgTransitEncryptionEnabled
- A flag that enables in-transit encryption when set totrue
. You cannot modify the value ofTransitEncryptionEnabled
after the cluster is created. To enable in-transit encryption on a cluster you must setTransitEncryptionEnabled
totrue
when you create a cluster. Default:false
rgSnapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example:05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.rgConfigurationEndpoint
- The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.rgAuthTokenEnabled
- A flag that enables using anAuthToken
(password) when issuing Redis commands. Default:false
rgMemberClusters
- The identifiers of all the nodes that are part of this replication group.rgSnapshotRetentionLimit
- The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you setSnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted. Important: If the value ofSnapshotRetentionLimit
is set to zero (0), backups are turned off.rgDescription
- The user supplied description of the replication group.rgReplicationGroupId
- The identifier for the replication group.rgPendingModifiedValues
- A group of settings to be applied to the replication group, either immediately or during the next maintenance window.rgAutomaticFailover
- Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.
rgStatus :: Lens' ReplicationGroup (Maybe Text) Source #
The current state of this replication group - creating
, available
, modifying
, deleting
, create-failed
, snapshotting
.
rgCacheNodeType :: Lens' ReplicationGroup (Maybe Text) Source #
The name of the compute and memory capacity node type for each node in the replication group.
rgNodeGroups :: Lens' ReplicationGroup [NodeGroup] Source #
A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
rgSnapshottingClusterId :: Lens' ReplicationGroup (Maybe Text) Source #
The cluster ID that is used as the daily snapshot source for the replication group.
rgClusterEnabled :: Lens' ReplicationGroup (Maybe Bool) Source #
A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). Valid values: true
| false
rgAtRestEncryptionEnabled :: Lens' ReplicationGroup (Maybe Bool) Source #
A flag that enables encryption at-rest when set to true
. You cannot modify the value of AtRestEncryptionEnabled
after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled
to true
when you create a cluster. Default: false
rgTransitEncryptionEnabled :: Lens' ReplicationGroup (Maybe Bool) Source #
A flag that enables in-transit encryption when set to true
. You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
to true
when you create a cluster. Default: false
rgSnapshotWindow :: Lens' ReplicationGroup (Maybe Text) Source #
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
rgConfigurationEndpoint :: Lens' ReplicationGroup (Maybe Endpoint) Source #
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
rgAuthTokenEnabled :: Lens' ReplicationGroup (Maybe Bool) Source #
A flag that enables using an AuthToken
(password) when issuing Redis commands. Default: false
rgMemberClusters :: Lens' ReplicationGroup [Text] Source #
The identifiers of all the nodes that are part of this replication group.
rgSnapshotRetentionLimit :: Lens' ReplicationGroup (Maybe Int) Source #
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted. Important: If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
rgDescription :: Lens' ReplicationGroup (Maybe Text) Source #
The user supplied 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 with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.
ReplicationGroupPendingModifiedValues
data ReplicationGroupPendingModifiedValues Source #
The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.
See: replicationGroupPendingModifiedValues
smart constructor.
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:
rgpmvResharding
- The status of an online resharding operation.rgpmvPrimaryClusterId
- The primary cluster ID that is applied immediately (if--apply-immediately
was specified), or during the next maintenance window.rgpmvAutomaticFailoverStatus
- Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.
rgpmvResharding :: Lens' ReplicationGroupPendingModifiedValues (Maybe ReshardingStatus) Source #
The status of an online resharding operation.
rgpmvPrimaryClusterId :: Lens' ReplicationGroupPendingModifiedValues (Maybe Text) Source #
The primary cluster ID that is 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 with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.
ReservedCacheNode
data ReservedCacheNode Source #
Represents the output of a PurchaseReservedCacheNodesOffering
operation.
See: reservedCacheNode
smart constructor.
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
- The cache node type for the reserved cache nodes. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types:cache.t2.micro
,cache.t2.small
,cache.t2.medium
M3 node types:cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
M4 node types:cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types:cache.t1.micro
M1 node types:cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types:cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types:cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types:cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .rcnState
- The state of the reserved cache node.rcnStartTime
- The time the reservation started.rcnProductDescription
- The description of the reserved cache node.rcnCacheNodeCount
- The number of cache nodes that have been reserved.rcnReservedCacheNodeId
- The unique identifier for the reservation.rcnRecurringCharges
- The recurring price charged to run this reserved cache node.rcnOfferingType
- The offering type of this reserved cache node.rcnUsagePrice
- The hourly price charged for this reserved cache node.rcnFixedPrice
- The fixed price charged for this reserved cache node.rcnDuration
- The duration of the reservation in seconds.rcnReservedCacheNodesOfferingId
- The offering identifier.
rcnCacheNodeType :: Lens' ReservedCacheNode (Maybe Text) Source #
The cache node type for the reserved cache nodes. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types: cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .
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.
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
- The cache node type for the reserved cache node. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types:cache.t2.micro
,cache.t2.small
,cache.t2.medium
M3 node types:cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
M4 node types:cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types:cache.t1.micro
M1 node types:cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types:cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types:cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types:cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .rcnoProductDescription
- The cache engine used by the offering.rcnoRecurringCharges
- The recurring price charged to run this reserved cache node.rcnoOfferingType
- The offering type.rcnoUsagePrice
- The hourly price charged for this offering.rcnoFixedPrice
- The fixed price charged for this offering.rcnoDuration
- The duration of the offering. in seconds.rcnoReservedCacheNodesOfferingId
- A unique identifier for the reserved cache node offering.
rcnoCacheNodeType :: Lens' ReservedCacheNodesOffering (Maybe Text) Source #
The cache node type for the reserved cache node. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types: cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either 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.
ReshardingConfiguration
data ReshardingConfiguration Source #
A list of PreferredAvailabilityZones
objects that specifies the configuration of a node group in the resharded cluster.
See: reshardingConfiguration
smart constructor.
reshardingConfiguration :: ReshardingConfiguration Source #
Creates a value of ReshardingConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcPreferredAvailabilityZones
- A list of preferred availability zones for the nodes in this cluster.
rcPreferredAvailabilityZones :: Lens' ReshardingConfiguration [Text] Source #
A list of preferred availability zones for the nodes in this cluster.
ReshardingStatus
data ReshardingStatus Source #
The status of an online resharding operation.
See: reshardingStatus
smart constructor.
reshardingStatus :: ReshardingStatus Source #
Creates a value of ReshardingStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsSlotMigration
- Represents the progress of an online resharding operation.
rsSlotMigration :: Lens' ReshardingStatus (Maybe SlotMigration) Source #
Represents the progress of an online resharding operation.
SecurityGroupMembership
data SecurityGroupMembership Source #
Represents a single cache security group and its status.
See: securityGroupMembership
smart constructor.
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
- 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 cluster are modified.sgmSecurityGroupId
- The identifier of the cache security group.
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 cluster are modified.
sgmSecurityGroupId :: Lens' SecurityGroupMembership (Maybe Text) Source #
The identifier of the cache security group.
SlotMigration
data SlotMigration Source #
Represents the progress of an online resharding operation.
See: slotMigration
smart constructor.
slotMigration :: SlotMigration Source #
Creates a value of SlotMigration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smProgressPercentage
- The percentage of the slot migration that is complete.
smProgressPercentage :: Lens' SlotMigration (Maybe Double) Source #
The percentage of the slot migration that is complete.
Snapshot
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
See: snapshot
smart constructor.
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
- The version of the cache engine version that is used by the source cluster.sCacheNodeType
- The name of the compute and memory capacity node type for the source cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types:cache.t2.micro
,cache.t2.small
,cache.t2.medium
M3 node types:cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
M4 node types:cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types:cache.t1.micro
M1 node types:cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types:cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types:cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types:cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .sCacheClusterCreateTime
- The date and time when the source cluster was created.sAutoMinorVersionUpgrade
- This parameter is currently disabled.sCacheParameterGroupName
- The cache parameter group that is associated with the source cluster.sReplicationGroupDescription
- A description of the source replication group.sVPCId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.sSnapshotStatus
- The status of the snapshot. Valid values:creating
|available
|restoring
|copying
|deleting
.sSnapshotWindow
- The daily time range during which ElastiCache takes daily snapshots of the source cluster.sCacheClusterId
- The user-supplied identifier of the source cluster.sEngine
- The name of the cache engine (memcached
orredis
) used by the source cluster.sPreferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values forddd
are: *sun
*mon
*tue
*wed
*thu
*fri
*sat
Example:sun:23:00-mon:01:30
sTopicARN
- The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.sNodeSnapshots
- A list of the cache nodes in the source cluster.sCacheSubnetGroupName
- The name of the cache subnet group associated with the source cluster.sPreferredAvailabilityZone
- The name of the Availability Zone in which the source cluster is located.sNumNodeGroups
- The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.sSnapshotRetentionLimit
- For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. For manual snapshots, this field reflects theSnapshotRetentionLimit
for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using theDeleteSnapshot
operation. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.sSnapshotName
- The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.sReplicationGroupId
- The unique identifier of the source replication group.sNumCacheNodes
- The number of cache nodes in the source cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.sPort
- The port number used by each cache nodes in the source cluster.sAutomaticFailover
- Indicates the status of Multi-AZ with automatic failover for the source Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.sSnapshotSource
- Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
sEngineVersion :: Lens' Snapshot (Maybe Text) Source #
The version of the cache engine version that is used by the source cluster.
sCacheNodeType :: Lens' Snapshot (Maybe Text) Source #
The name of the compute and memory capacity node type for the source cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. * General purpose: * Current generation: T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
* Previous generation: (not recommended) T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
, cache.m1.xlarge
* Compute optimized: * Previous generation: (not recommended) C1 node types: cache.c1.xlarge
* Memory optimized: * Current generation: R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
* Previous generation: (not recommended) M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes: * All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). * Redis (cluster mode disabled): Redis backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore is not supported on T1 instances. * Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either 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 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 cluster.
sReplicationGroupDescription :: Lens' Snapshot (Maybe Text) Source #
A description of the source replication group.
sVPCId :: Lens' Snapshot (Maybe Text) Source #
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source 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 cluster.
sCacheClusterId :: Lens' Snapshot (Maybe Text) Source #
The user-supplied identifier of the source cluster.
sEngine :: Lens' Snapshot (Maybe Text) Source #
The name of the cache engine (memcached
or redis
) used by the source cluster.
sPreferredMaintenanceWindow :: Lens' Snapshot (Maybe Text) Source #
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd
are: * sun
* mon
* tue
* wed
* thu
* fri
* sat
Example: sun:23:00-mon:01:30
sTopicARN :: Lens' Snapshot (Maybe Text) Source #
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
sNodeSnapshots :: Lens' Snapshot [NodeSnapshot] Source #
A list of the cache nodes in the source cluster.
sCacheSubnetGroupName :: Lens' Snapshot (Maybe Text) Source #
The name of the cache subnet group associated with the source cluster.
sPreferredAvailabilityZone :: Lens' Snapshot (Maybe Text) Source #
The name of the Availability Zone in which the source cluster is located.
sNumNodeGroups :: Lens' Snapshot (Maybe Int) Source #
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
sSnapshotRetentionLimit :: Lens' Snapshot (Maybe Int) Source #
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot
operation. 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.
sReplicationGroupId :: Lens' Snapshot (Maybe Text) Source #
The unique identifier of the source replication group.
sNumCacheNodes :: Lens' Snapshot (Maybe Int) Source #
The number of cache nodes in the source 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 cluster.
sAutomaticFailover :: Lens' Snapshot (Maybe AutomaticFailoverStatus) Source #
Indicates the status of Multi-AZ with automatic failover for the source Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: * Redis versions earlier than 2.8.6. * Redis (cluster mode disabled): T1 and T2 cache node types. * Redis (cluster mode enabled): T1 node types.
sSnapshotSource :: Lens' Snapshot (Maybe Text) Source #
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
Subnet
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
See: subnet
smart constructor.
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
- The unique identifier for the subnet.sSubnetAvailabilityZone
- The Availability Zone associated with the subnet.
sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source #
The Availability Zone associated with the subnet.
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.
TagListMessage
data TagListMessage Source #
Represents the output from the AddTagsToResource
, ListTagsForResource
, and RemoveTagsFromResource
operations.
See: tagListMessage
smart constructor.
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
- A list of cost allocation tags as key-value pairs.
tlmTagList :: Lens' TagListMessage [Tag] Source #
A list of cost allocation tags as key-value pairs.