amazonka-elasticache-0.0.3: Amazon ElastiCache SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.Types

Contents

Synopsis

Service

data ElastiCache Source

Version 2014-09-30 of the Amazon ElastiCache service.

Error

data RESTError :: *

Instances

Eq RESTError 
Show RESTError 
Generic RESTError 
FromXML RESTError 
type Rep RESTError = D1 D1RESTError (C1 C1_0RESTError ((:*:) ((:*:) (S1 S1_0_0RESTError (Rec0 Text)) (S1 S1_0_1RESTError (Rec0 (Maybe ErrorType)))) ((:*:) (S1 S1_0_2RESTError (Rec0 Text)) (S1 S1_0_3RESTError (Rec0 Text))))) 

XML

NodeSnapshot

nsCacheNodeCreateTime :: Lens' NodeSnapshot (Maybe UTCTime) Source

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

nsCacheNodeId :: Lens' NodeSnapshot (Maybe Text) Source

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

nsCacheSize :: Lens' NodeSnapshot (Maybe Text) Source

The size of the cache on the source cache node.

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.

Snapshot

sAutoMinorVersionUpgrade :: Lens' Snapshot (Maybe Bool) Source

For the source cache cluster, indicates whether minor version patches are applied automatically (true) or not (false).

sCacheClusterCreateTime :: Lens' Snapshot (Maybe UTCTime) Source

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

sCacheClusterId :: Lens' Snapshot (Maybe Text) Source

The user-supplied identifier of the source cache cluster.

sCacheNodeType :: Lens' Snapshot (Maybe Text) Source

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

sCacheParameterGroupName :: Lens' Snapshot (Maybe Text) Source

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

sCacheSubnetGroupName :: Lens' Snapshot (Maybe Text) Source

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

sEngine :: Lens' Snapshot (Maybe Text) Source

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

sEngineVersion :: Lens' Snapshot (Maybe Text) Source

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

sNodeSnapshots :: Lens' Snapshot [NodeSnapshot] Source

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

sNumCacheNodes :: Lens' Snapshot (Maybe Int) Source

The number of cache nodes in the source cache cluster.

sPort :: Lens' Snapshot (Maybe Int) Source

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

sPreferredAvailabilityZone :: Lens' Snapshot (Maybe Text) Source

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

sPreferredMaintenanceWindow :: Lens' Snapshot (Maybe Text) Source

The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.

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.

sSnapshotRetentionLimit :: Lens' Snapshot (Maybe Int) Source

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

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

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

sSnapshotSource :: Lens' Snapshot (Maybe Text) Source

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

sSnapshotStatus :: Lens' Snapshot (Maybe Text) Source

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

sSnapshotWindow :: Lens' Snapshot (Maybe Text) Source

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

sTopicArn :: Lens' Snapshot (Maybe Text) Source

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

sVpcId :: Lens' Snapshot (Maybe Text) Source

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

Event

event :: Event Source

Event constructor.

The fields accessible through corresponding lenses are:

eDate :: Lens' Event (Maybe UTCTime) Source

The date and time when the event occurred.

eMessage :: Lens' Event (Maybe Text) Source

The text of the event.

eSourceIdentifier :: Lens' Event (Maybe Text) Source

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

eSourceType :: Lens' Event (Maybe SourceType) Source

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

NodeGroup

nodeGroup :: NodeGroup Source

NodeGroup constructor.

The fields accessible through corresponding lenses are:

ngNodeGroupId :: Lens' NodeGroup (Maybe Text) Source

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

ngNodeGroupMembers :: Lens' NodeGroup [NodeGroupMember] Source

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

ngStatus :: Lens' NodeGroup (Maybe Text) Source

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

CacheNodeTypeSpecificValue

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.

PendingAutomaticFailoverStatus

NotificationConfiguration

notificationConfiguration :: NotificationConfiguration Source

NotificationConfiguration constructor.

The fields accessible through corresponding lenses are:

ncTopicArn :: Lens' NotificationConfiguration (Maybe Text) Source

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

ncTopicStatus :: Lens' NotificationConfiguration (Maybe Text) Source

The current state of the topic.

ReplicationGroupPendingModifiedValues

rgpmvAutomaticFailoverStatus :: Lens' ReplicationGroupPendingModifiedValues (Maybe PendingAutomaticFailoverStatus) Source

Indicates the status of automatic failover for this replication group.

rgpmvPrimaryClusterId :: Lens' ReplicationGroupPendingModifiedValues (Maybe Text) Source

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

EC2SecurityGroup

ecsgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text) Source

The name of the Amazon EC2 security group.

ecsgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text) Source

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

ecsgStatus :: Lens' EC2SecurityGroup (Maybe Text) Source

The status of the Amazon EC2 security group.

ParameterNameValue

parameterNameValue :: ParameterNameValue Source

ParameterNameValue constructor.

The fields accessible through corresponding lenses are:

pnvParameterName :: Lens' ParameterNameValue (Maybe Text) Source

The name of the parameter.

pnvParameterValue :: Lens' ParameterNameValue (Maybe Text) Source

The value of the parameter.

SourceType

CacheSubnetGroup

csgCacheSubnetGroupDescription :: Lens' CacheSubnetGroup (Maybe Text) Source

The description of the cache subnet group.

csgCacheSubnetGroupName :: Lens' CacheSubnetGroup (Maybe Text) Source

The name of the cache subnet group.

csgSubnets :: Lens' CacheSubnetGroup [Subnet] Source

A list of subnets associated with the cache subnet group.

csgVpcId :: Lens' CacheSubnetGroup (Maybe Text) Source

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

ReservedCacheNode

rcnCacheNodeCount :: Lens' ReservedCacheNode (Maybe Int) Source

The number of cache nodes that have been reserved.

rcnCacheNodeType :: Lens' ReservedCacheNode (Maybe Text) Source

The cache node type for the reserved cache nodes.

rcnDuration :: Lens' ReservedCacheNode (Maybe Int) Source

The duration of the reservation in seconds.

rcnFixedPrice :: Lens' ReservedCacheNode (Maybe Double) Source

The fixed price charged for this reserved cache node.

rcnOfferingType :: Lens' ReservedCacheNode (Maybe Text) Source

The offering type of this reserved cache node.

rcnProductDescription :: Lens' ReservedCacheNode (Maybe Text) Source

The description of the reserved cache node.

rcnRecurringCharges :: Lens' ReservedCacheNode [RecurringCharge] Source

The recurring price charged to run this reserved cache node.

rcnReservedCacheNodeId :: Lens' ReservedCacheNode (Maybe Text) Source

The unique identifier for the reservation.

rcnStartTime :: Lens' ReservedCacheNode (Maybe UTCTime) Source

The time the reservation started.

rcnState :: Lens' ReservedCacheNode (Maybe Text) Source

The state of the reserved cache node.

rcnUsagePrice :: Lens' ReservedCacheNode (Maybe Double) Source

The hourly price charged for this reserved cache node.

Subnet

subnet :: Subnet Source

Subnet constructor.

The fields accessible through corresponding lenses are:

sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source

The Availability Zone associated with the subnet

sSubnetIdentifier :: Lens' Subnet (Maybe Text) Source

The unique identifier for the subnet

SecurityGroupMembership

securityGroupMembership :: SecurityGroupMembership Source

SecurityGroupMembership constructor.

The fields accessible through corresponding lenses are:

sgmSecurityGroupId :: Lens' SecurityGroupMembership (Maybe Text) Source

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 cache cluster are modified.

CacheCluster

ccAutoMinorVersionUpgrade :: Lens' CacheCluster (Maybe Bool) Source

If true, then minor version patches are applied automatically; if false, then automatic minor version patches are disabled.

ccCacheClusterCreateTime :: Lens' CacheCluster (Maybe UTCTime) Source

The date and time when the cache cluster was created.

ccCacheClusterId :: Lens' CacheCluster (Maybe Text) Source

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

ccCacheClusterStatus :: Lens' CacheCluster (Maybe Text) Source

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

ccCacheNodeType :: Lens' CacheCluster (Maybe Text) Source

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

ccCacheNodes :: Lens' CacheCluster [CacheNode] Source

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

ccCacheSecurityGroups :: Lens' CacheCluster [CacheSecurityGroupMembership] Source

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

ccCacheSubnetGroupName :: Lens' CacheCluster (Maybe Text) Source

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

ccClientDownloadLandingPage :: Lens' CacheCluster (Maybe Text) Source

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

ccEngine :: Lens' CacheCluster (Maybe Text) Source

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

ccEngineVersion :: Lens' CacheCluster (Maybe Text) Source

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

ccNumCacheNodes :: Lens' CacheCluster (Maybe Int) Source

The number of cache nodes in the cache cluster.

ccPreferredAvailabilityZone :: Lens' CacheCluster (Maybe Text) Source

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

ccPreferredMaintenanceWindow :: Lens' CacheCluster (Maybe Text) Source

The time range (in UTC) during which weekly system maintenance can occur.

ccReplicationGroupId :: Lens' CacheCluster (Maybe Text) Source

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

ccSecurityGroups :: Lens' CacheCluster [SecurityGroupMembership] Source

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

ccSnapshotRetentionLimit :: Lens' CacheCluster (Maybe Int) Source

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

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

ccSnapshotWindow :: Lens' CacheCluster (Maybe Text) Source

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

Example: '05:00-09:00'

EngineDefaults

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.

edCacheParameterGroupFamily :: Lens' EngineDefaults (Maybe Text) Source

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

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.

CacheParameterGroupStatus

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

cpgsCacheParameterGroupName :: Lens' CacheParameterGroupStatus (Maybe Text) Source

The name of the cache parameter group.

CacheNode

cnCacheNodeCreateTime :: Lens' CacheNode (Maybe UTCTime) Source

The date and time when the cache node was created.

cnCacheNodeId :: Lens' CacheNode (Maybe Text) Source

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

cnCacheNodeStatus :: Lens' CacheNode (Maybe Text) Source

The current state of this cache node.

cnCustomerAvailabilityZone :: Lens' CacheNode (Maybe Text) Source

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

cnEndpoint :: Lens' CacheNode (Maybe Endpoint) Source

The hostname and IP address for connecting to this cache node.

cnParameterGroupStatus :: Lens' CacheNode (Maybe Text) Source

The status of the parameter group applied 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, then this node is not associated with a primary cache cluster.

CacheSecurityGroupMembership

csgmStatus :: Lens' CacheSecurityGroupMembership (Maybe Text) Source

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

AvailabilityZone

availabilityZone :: AvailabilityZone Source

AvailabilityZone constructor.

The fields accessible through corresponding lenses are:

azName :: Lens' AvailabilityZone (Maybe Text) Source

The name of the Availability Zone.

NodeGroupMember

ngmCacheClusterId :: Lens' NodeGroupMember (Maybe Text) Source

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

ngmCacheNodeId :: Lens' NodeGroupMember (Maybe Text) Source

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

ngmCurrentRole :: Lens' NodeGroupMember (Maybe Text) Source

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

ngmPreferredAvailabilityZone :: Lens' NodeGroupMember (Maybe Text) Source

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

CacheParameterGroup

cpgCacheParameterGroupFamily :: Lens' CacheParameterGroup (Maybe Text) Source

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

cpgCacheParameterGroupName :: Lens' CacheParameterGroup (Maybe Text) Source

The name of the cache parameter group.

cpgDescription :: Lens' CacheParameterGroup (Maybe Text) Source

The description for this cache parameter group.

AutomaticFailoverStatus

CacheSecurityGroup

csgCacheSecurityGroupName :: Lens' CacheSecurityGroup (Maybe Text) Source

The name of the cache security group.

csgDescription :: Lens' CacheSecurityGroup (Maybe Text) Source

The description of the cache security group.

csgEC2SecurityGroups :: Lens' CacheSecurityGroup [EC2SecurityGroup] Source

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

csgOwnerId :: Lens' CacheSecurityGroup (Maybe Text) Source

The AWS account ID of the cache security group owner.

CacheNodeTypeSpecificParameter

cntspAllowedValues :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

The valid range of values for the parameter.

cntspCacheNodeTypeSpecificValues :: Lens' CacheNodeTypeSpecificParameter [CacheNodeTypeSpecificValue] Source

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

cntspDataType :: Lens' CacheNodeTypeSpecificParameter (Maybe Text) Source

The valid data type for the parameter.

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.

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.

AZMode

CacheEngineVersion

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.

cevCacheParameterGroupFamily :: Lens' CacheEngineVersion (Maybe Text) Source

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

cevEngine :: Lens' CacheEngineVersion (Maybe Text) Source

The name of the cache engine.

cevEngineVersion :: Lens' CacheEngineVersion (Maybe Text) Source

The version number of the cache engine.

ReplicationGroup

rgAutomaticFailover :: Lens' ReplicationGroup (Maybe AutomaticFailoverStatus) Source

Indicates the status of automatic failover for this replication group.

rgDescription :: Lens' ReplicationGroup (Maybe Text) Source

The description of the replication group.

rgMemberClusters :: Lens' ReplicationGroup [Text] Source

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

rgNodeGroups :: Lens' ReplicationGroup [NodeGroup] Source

A single element list with information about the nodes in 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.

rgReplicationGroupId :: Lens' ReplicationGroup (Maybe Text) Source

The identifier for the replication group.

rgSnapshottingClusterId :: Lens' ReplicationGroup (Maybe Text) Source

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

rgStatus :: Lens' ReplicationGroup (Maybe Text) Source

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

RecurringCharge

recurringCharge :: RecurringCharge Source

RecurringCharge constructor.

The fields accessible through corresponding lenses are:

rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source

The monetary amount of the recurring charge.

rcRecurringChargeFrequency :: Lens' RecurringCharge (Maybe Text) Source

The frequency of the recurring charge.

ReservedCacheNodesOffering

rcnoCacheNodeType :: Lens' ReservedCacheNodesOffering (Maybe Text) Source

The cache node type for the reserved cache node.

rcnoDuration :: Lens' ReservedCacheNodesOffering (Maybe Int) Source

The duration of the offering. in seconds.

rcnoFixedPrice :: Lens' ReservedCacheNodesOffering (Maybe Double) Source

The fixed price charged for this offering.

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.

rcnoReservedCacheNodesOfferingId :: Lens' ReservedCacheNodesOffering (Maybe Text) Source

A unique identifier for the reserved cache node offering.

rcnoUsagePrice :: Lens' ReservedCacheNodesOffering (Maybe Double) Source

The hourly price charged for this offering.

Endpoint

endpoint :: Endpoint Source

Endpoint constructor.

The fields accessible through corresponding lenses are:

eAddress :: Lens' Endpoint (Maybe Text) Source

The DNS hostname of the cache node.

ePort :: Lens' Endpoint (Maybe Int) Source

The port number that the cache engine is listening on.

PendingModifiedValues

pmvCacheNodeIdsToRemove :: Lens' PendingModifiedValues [Text] Source

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

pmvEngineVersion :: Lens' PendingModifiedValues (Maybe Text) Source

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

pmvNumCacheNodes :: Lens' PendingModifiedValues (Maybe Int) Source

The new number of cache nodes for the cache cluster.

CacheParameterGroupNameMessage

Parameter

pAllowedValues :: Lens' Parameter (Maybe Text) Source

The valid range of values for the parameter.

pDataType :: Lens' Parameter (Maybe Text) Source

The valid data type for the parameter.

pDescription :: Lens' Parameter (Maybe Text) Source

A description of the parameter.

pIsModifiable :: Lens' Parameter (Maybe Bool) Source

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

pMinimumEngineVersion :: Lens' Parameter (Maybe Text) Source

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

pParameterName :: Lens' Parameter (Maybe Text) Source

The name of the parameter.

pParameterValue :: Lens' Parameter (Maybe Text) Source

The value of the parameter.

pSource :: Lens' Parameter (Maybe Text) Source

The source of the parameter.