Package software.amazon.awssdk.services.elasticache.model

Class CacheCluster

    • Method Detail

      • cacheClusterId

        public final String cacheClusterId()

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

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

      • configurationEndpoint

        public final Endpoint 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

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

      • clientDownloadLandingPage

        public final String clientDownloadLandingPage()

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

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

      • cacheNodeType

        public final String 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:

            M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

            For region availability, see Supported Node Types

            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

            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:

            R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

            For region availability, see Supported Node Types

            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

            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.

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

            M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

            For region availability, see Supported Node Types

            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

            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:

            R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

            For region availability, see Supported Node Types

            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

            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.

      • engine

        public final String engine()

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

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

      • engineVersion

        public final String engineVersion()

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

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

      • cacheClusterStatus

        public final String 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.

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

      • numCacheNodes

        public final Integer 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.

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

      • preferredAvailabilityZone

        public final String 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.

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

      • preferredOutpostArn

        public final String preferredOutpostArn()

        The outpost ARN in which the cache cluster is created.

        Returns:
        The outpost ARN in which the cache cluster is created.

      • cacheClusterCreateTime

        public final Instant cacheClusterCreateTime()

        The date and time when the cluster was created.

        Returns:
        The date and time when the cluster was created.

      • preferredMaintenanceWindow

        public final String 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

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

      • pendingModifiedValues

        public final PendingModifiedValues pendingModifiedValues()
        Returns the value of the PendingModifiedValues property for this object.
        Returns:
        The value of the PendingModifiedValues property for this object.

      • notificationConfiguration

        public final NotificationConfiguration notificationConfiguration()

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

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

      • hasCacheSecurityGroups

        public final boolean hasCacheSecurityGroups()
        For responses, this returns true if the service returned a value for the CacheSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • cacheSecurityGroups

        public final List<CacheSecurityGroupMembership> cacheSecurityGroups()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCacheSecurityGroups() method.

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

      • cacheParameterGroup

        public final CacheParameterGroupStatus cacheParameterGroup()

        Status of the cache parameter group.

        Returns:
        Status of the cache parameter group.

      • cacheSubnetGroupName

        public final String cacheSubnetGroupName()

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

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

      • hasCacheNodes

        public final boolean hasCacheNodes()
        For responses, this returns true if the service returned a value for the CacheNodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • cacheNodes

        public final List<CacheNode> cacheNodes()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCacheNodes() method.

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

      • autoMinorVersionUpgrade

        public final Boolean 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. 

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

      • hasSecurityGroups

        public final boolean hasSecurityGroups()
        For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • securityGroups

        public final List<SecurityGroupMembership> securityGroups()

        A list of VPC Security Groups associated with the cluster.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

        Returns:
        A list of VPC Security Groups associated with the cluster.

      • replicationGroupId

        public final String replicationGroupId()

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

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

      • snapshotRetentionLimit

        public final Integer 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.

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

        public final String snapshotWindow()

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

        Example: 05:00-09:00

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

        Example: 05:00-09:00

      • authTokenEnabled

        public final Boolean authTokenEnabled()

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

        Default: false

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

        Default: false

      • authTokenLastModifiedDate

        public final Instant authTokenLastModifiedDate()

        The date the auth token was last modified

        Returns:
        The date the auth token was last modified

      • transitEncryptionEnabled

        public final Boolean 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

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

      • atRestEncryptionEnabled

        public final Boolean 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

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

      • arn

        public final String arn()

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

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

      • replicationGroupLogDeliveryEnabled

        public final Boolean replicationGroupLogDeliveryEnabled()

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

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

      • hasLogDeliveryConfigurations

        public final boolean hasLogDeliveryConfigurations()
        For responses, this returns true if the service returned a value for the LogDeliveryConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • logDeliveryConfigurations

        public final List<LogDeliveryConfiguration> logDeliveryConfigurations()

        Returns the destination, format and type of the logs.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogDeliveryConfigurations() method.

        Returns:
        Returns the destination, format and type of the logs.

      • networkType

        public final NetworkType 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.

        If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

        Returns:
        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.
        See Also:
        NetworkType

      • networkTypeAsString

        public final String networkTypeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

        Returns:
        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.
        See Also:
        NetworkType

      • ipDiscovery

        public final IpDiscovery 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.

        If the service returns an enum value that is not available in the current SDK version, ipDiscovery will return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipDiscoveryAsString().

        Returns:
        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.
        See Also:
        IpDiscovery

      • ipDiscoveryAsString

        public final String ipDiscoveryAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, ipDiscovery will return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipDiscoveryAsString().

        Returns:
        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.
        See Also:
        IpDiscovery

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)