amazonka-elasticache-2.0: Amazon ElastiCache SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ElastiCache.Types.CacheCluster

Description

 
Synopsis

Documentation

data CacheCluster Source #

Contains all of the attributes of a specific cluster.

See: newCacheCluster smart constructor.

Constructors

CacheCluster' 

Fields

  • arn :: Maybe Text

    The ARN (Amazon Resource Name) of the cache cluster.

  • atRestEncryptionEnabled :: Maybe Bool

    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.

    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

    Default: false

  • authTokenEnabled :: Maybe Bool

    A flag that enables using an AuthToken (password) when issuing Redis commands.

    Default: false

  • authTokenLastModifiedDate :: Maybe ISO8601

    The date the auth token was last modified

  • autoMinorVersionUpgrade :: Maybe Bool

    If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

  • cacheClusterCreateTime :: Maybe ISO8601

    The date and time when the cluster was created.

  • cacheClusterId :: Maybe Text

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

  • cacheClusterStatus :: Maybe Text

    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.

  • cacheNodeType :: Maybe Text

    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:

        M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

        For region availability, see Supported Node Types

        M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

        M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

        T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

        T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        T1 node types: cache.t1.micro

        M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

        M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

        cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

        For region availability, see Supported Node Types

        R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

        R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

        R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    Additional node type info

    • All current generation instance types are created in Amazon VPC by default.
    • Redis append-only files (AOF) are not supported for T1 or T2 instances.
    • Redis Multi-AZ with automatic failover is not supported on T1 instances.
    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
  • cacheNodes :: Maybe [CacheNode]

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

  • cacheParameterGroup :: Maybe CacheParameterGroupStatus

    Status of the cache parameter group.

  • cacheSecurityGroups :: Maybe [CacheSecurityGroupMembership]

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

  • cacheSubnetGroupName :: Maybe Text

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

  • clientDownloadLandingPage :: Maybe Text

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

  • configurationEndpoint :: Maybe Endpoint

    Represents a Memcached cluster endpoint which 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

  • engine :: Maybe Text

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

  • engineVersion :: Maybe Text

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

  • ipDiscovery :: Maybe IpDiscovery

    The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

  • logDeliveryConfigurations :: Maybe [LogDeliveryConfiguration]

    Returns the destination, format and type of the logs.

  • networkType :: Maybe NetworkType

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

  • notificationConfiguration :: Maybe NotificationConfiguration

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

  • numCacheNodes :: Maybe Int

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

  • pendingModifiedValues :: Maybe PendingModifiedValues
     
  • preferredAvailabilityZone :: Maybe Text

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

  • preferredMaintenanceWindow :: Maybe Text

    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

  • preferredOutpostArn :: Maybe Text

    The outpost ARN in which the cache cluster is created.

  • replicationGroupId :: Maybe Text

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

  • replicationGroupLogDeliveryEnabled :: Maybe Bool

    A boolean value indicating whether log delivery is enabled for the replication group.

  • securityGroups :: Maybe [SecurityGroupMembership]

    A list of VPC Security Groups associated with the cluster.

  • snapshotRetentionLimit :: Maybe Int

    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.

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

  • snapshotWindow :: Maybe Text

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

    Example: 05:00-09:00

  • transitEncryptionEnabled :: Maybe Bool

    A flag that enables in-transit encryption when set to true.

    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

    Default: false

  • transitEncryptionMode :: Maybe TransitEncryptionMode

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Instances

Instances details
FromXML CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

Methods

parseXML :: [Node] -> Either String CacheCluster #

Generic CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

Associated Types

type Rep CacheCluster :: Type -> Type #

Methods

from :: CacheCluster -> Rep CacheCluster x #

to :: Rep CacheCluster x -> CacheCluster #

Read CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

Methods

readsPrec :: Int -> ReadS CacheCluster #

readList :: ReadS [CacheCluster] #

readPrec :: ReadPrec CacheCluster #

readListPrec :: ReadPrec [CacheCluster] #

Show CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

Methods

showsPrec :: Int -> CacheCluster -> ShowS #

show :: CacheCluster -> String #

showList :: [CacheCluster] -> ShowS #

NFData CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

Methods

rnf :: CacheCluster -> () #

Eq CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

Methods

(==) :: CacheCluster -> CacheCluster -> Bool #

(/=) :: CacheCluster -> CacheCluster -> Bool #

Hashable CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

Methods

hashWithSalt :: Int -> CacheCluster -> Int #

hash :: CacheCluster -> Int #

type Rep CacheCluster Source # 
Instance details

Defined in Amazonka.ElastiCache.Types.CacheCluster

type Rep CacheCluster = D1 ('MetaData "CacheCluster" "Amazonka.ElastiCache.Types.CacheCluster" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "CacheCluster'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "atRestEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "authTokenEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "authTokenLastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: ((S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cacheClusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "cacheClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cacheClusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "cacheNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cacheNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CacheNode]))) :*: (S1 ('MetaSel ('Just "cacheParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheParameterGroupStatus)) :*: S1 ('MetaSel ('Just "cacheSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CacheSecurityGroupMembership])))) :*: ((S1 ('MetaSel ('Just "cacheSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientDownloadLandingPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "configurationEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: ((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ipDiscovery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpDiscovery))) :*: (S1 ('MetaSel ('Just "logDeliveryConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LogDeliveryConfiguration])) :*: S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkType)))) :*: ((S1 ('MetaSel ('Just "notificationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationConfiguration)) :*: S1 ('MetaSel ('Just "numCacheNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingModifiedValues)) :*: S1 ('MetaSel ('Just "preferredAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredOutpostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "replicationGroupLogDeliveryEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecurityGroupMembership])) :*: S1 ('MetaSel ('Just "snapshotRetentionLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "snapshotWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "transitEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "transitEncryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransitEncryptionMode)))))))))

newCacheCluster :: CacheCluster Source #

Create a value of CacheCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:CacheCluster', cacheCluster_arn - The ARN (Amazon Resource Name) of the cache cluster.

$sel:atRestEncryptionEnabled:CacheCluster', cacheCluster_atRestEncryptionEnabled - 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.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

$sel:authTokenEnabled:CacheCluster', cacheCluster_authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

$sel:authTokenLastModifiedDate:CacheCluster', cacheCluster_authTokenLastModifiedDate - The date the auth token was last modified

$sel:autoMinorVersionUpgrade:CacheCluster', cacheCluster_autoMinorVersionUpgrade - If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

$sel:cacheClusterCreateTime:CacheCluster', cacheCluster_cacheClusterCreateTime - The date and time when the cluster was created.

$sel:cacheClusterId:CacheCluster', cacheCluster_cacheClusterId - The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

$sel:cacheClusterStatus:CacheCluster', cacheCluster_cacheClusterStatus - 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.

CacheCluster, cacheCluster_cacheNodeType - 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:

      M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

      For region availability, see Supported Node Types

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

      cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

      For region availability, see Supported Node Types

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.
  • Redis append-only files (AOF) are not supported for T1 or T2 instances.
  • Redis Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

$sel:cacheNodes:CacheCluster', cacheCluster_cacheNodes - A list of cache nodes that are members of the cluster.

$sel:cacheParameterGroup:CacheCluster', cacheCluster_cacheParameterGroup - Status of the cache parameter group.

$sel:cacheSecurityGroups:CacheCluster', cacheCluster_cacheSecurityGroups - A list of cache security group elements, composed of name and status sub-elements.

$sel:cacheSubnetGroupName:CacheCluster', cacheCluster_cacheSubnetGroupName - The name of the cache subnet group associated with the cluster.

$sel:clientDownloadLandingPage:CacheCluster', cacheCluster_clientDownloadLandingPage - The URL of the web page where you can download the latest ElastiCache client library.

$sel:configurationEndpoint:CacheCluster', cacheCluster_configurationEndpoint - Represents a Memcached cluster endpoint which 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

$sel:engine:CacheCluster', cacheCluster_engine - The name of the cache engine (memcached or redis) to be used for this cluster.

CacheCluster, cacheCluster_engineVersion - The version of the cache engine that is used in this cluster.

$sel:ipDiscovery:CacheCluster', cacheCluster_ipDiscovery - The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

CacheCluster, cacheCluster_logDeliveryConfigurations - Returns the destination, format and type of the logs.

$sel:networkType:CacheCluster', cacheCluster_networkType - Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

$sel:notificationConfiguration:CacheCluster', cacheCluster_notificationConfiguration - Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

CacheCluster, cacheCluster_numCacheNodes - 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 40.

$sel:pendingModifiedValues:CacheCluster', cacheCluster_pendingModifiedValues - Undocumented member.

$sel:preferredAvailabilityZone:CacheCluster', cacheCluster_preferredAvailabilityZone - The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

$sel:preferredMaintenanceWindow:CacheCluster', cacheCluster_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

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

Example: sun:23:00-mon:01:30

$sel:preferredOutpostArn:CacheCluster', cacheCluster_preferredOutpostArn - The outpost ARN in which the cache cluster is created.

$sel:replicationGroupId:CacheCluster', cacheCluster_replicationGroupId - The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

$sel:replicationGroupLogDeliveryEnabled:CacheCluster', cacheCluster_replicationGroupLogDeliveryEnabled - A boolean value indicating whether log delivery is enabled for the replication group.

$sel:securityGroups:CacheCluster', cacheCluster_securityGroups - A list of VPC Security Groups associated with the cluster.

$sel:snapshotRetentionLimit:CacheCluster', cacheCluster_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

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

$sel:snapshotWindow:CacheCluster', cacheCluster_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Example: 05:00-09:00

CacheCluster, cacheCluster_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

CacheCluster, cacheCluster_transitEncryptionMode - A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

cacheCluster_arn :: Lens' CacheCluster (Maybe Text) Source #

The ARN (Amazon Resource Name) of the cache cluster.

cacheCluster_atRestEncryptionEnabled :: 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.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

cacheCluster_authTokenEnabled :: Lens' CacheCluster (Maybe Bool) Source #

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

cacheCluster_authTokenLastModifiedDate :: Lens' CacheCluster (Maybe UTCTime) Source #

The date the auth token was last modified

cacheCluster_autoMinorVersionUpgrade :: Lens' CacheCluster (Maybe Bool) Source #

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

cacheCluster_cacheClusterCreateTime :: Lens' CacheCluster (Maybe UTCTime) Source #

The date and time when the cluster was created.

cacheCluster_cacheClusterId :: Lens' CacheCluster (Maybe Text) Source #

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

cacheCluster_cacheClusterStatus :: 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.

cacheCluster_cacheNodeType :: 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:

      M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

      For region availability, see Supported Node Types

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

      cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

      For region availability, see Supported Node Types

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.
  • Redis append-only files (AOF) are not supported for T1 or T2 instances.
  • Redis Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

cacheCluster_cacheNodes :: Lens' CacheCluster (Maybe [CacheNode]) Source #

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

cacheCluster_cacheParameterGroup :: Lens' CacheCluster (Maybe CacheParameterGroupStatus) Source #

Status of the cache parameter group.

cacheCluster_cacheSecurityGroups :: Lens' CacheCluster (Maybe [CacheSecurityGroupMembership]) Source #

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

cacheCluster_cacheSubnetGroupName :: Lens' CacheCluster (Maybe Text) Source #

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

cacheCluster_clientDownloadLandingPage :: Lens' CacheCluster (Maybe Text) Source #

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

cacheCluster_configurationEndpoint :: Lens' CacheCluster (Maybe Endpoint) Source #

Represents a Memcached cluster endpoint which 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

cacheCluster_engine :: Lens' CacheCluster (Maybe Text) Source #

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

cacheCluster_engineVersion :: Lens' CacheCluster (Maybe Text) Source #

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

cacheCluster_ipDiscovery :: Lens' CacheCluster (Maybe IpDiscovery) Source #

The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

cacheCluster_logDeliveryConfigurations :: Lens' CacheCluster (Maybe [LogDeliveryConfiguration]) Source #

Returns the destination, format and type of the logs.

cacheCluster_networkType :: Lens' CacheCluster (Maybe NetworkType) Source #

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

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

cacheCluster_numCacheNodes :: 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 40.

cacheCluster_pendingModifiedValues :: Lens' CacheCluster (Maybe PendingModifiedValues) Source #

Undocumented member.

cacheCluster_preferredAvailabilityZone :: 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.

cacheCluster_preferredMaintenanceWindow :: 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

cacheCluster_preferredOutpostArn :: Lens' CacheCluster (Maybe Text) Source #

The outpost ARN in which the cache cluster is created.

cacheCluster_replicationGroupId :: 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.

cacheCluster_replicationGroupLogDeliveryEnabled :: Lens' CacheCluster (Maybe Bool) Source #

A boolean value indicating whether log delivery is enabled for the replication group.

cacheCluster_securityGroups :: Lens' CacheCluster (Maybe [SecurityGroupMembership]) Source #

A list of VPC Security Groups associated with the cluster.

cacheCluster_snapshotRetentionLimit :: 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.

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

cacheCluster_snapshotWindow :: 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

cacheCluster_transitEncryptionEnabled :: Lens' CacheCluster (Maybe Bool) Source #

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

cacheCluster_transitEncryptionMode :: Lens' CacheCluster (Maybe TransitEncryptionMode) Source #

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.