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

Class ConfigureShard

    • Method Detail

      • nodeGroupId

        public final String nodeGroupId()

        The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

        Returns:
        The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

      • newReplicaCount

        public final Integer newReplicaCount()

        The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

        The minimum number of replicas in a shard or replication group is:

        • Redis OSS (cluster mode disabled)

          • If Multi-AZ: 1

          • If Multi-AZ: 0

        • Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

        Returns:
        The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

        The minimum number of replicas in a shard or replication group is:

        • Redis OSS (cluster mode disabled)

          • If Multi-AZ: 1

          • If Multi-AZ: 0

        • Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

      • hasPreferredAvailabilityZones

        public final boolean hasPreferredAvailabilityZones()
        For responses, this returns true if the service returned a value for the PreferredAvailabilityZones 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.

      • preferredAvailabilityZones

        public final List<String> preferredAvailabilityZones()

        A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

        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 hasPreferredAvailabilityZones() method.

        Returns:
        A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

      • hasPreferredOutpostArns

        public final boolean hasPreferredOutpostArns()
        For responses, this returns true if the service returned a value for the PreferredOutpostArns 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.

      • preferredOutpostArns

        public final List<String> preferredOutpostArns()

        The outpost ARNs in which the cache cluster is created.

        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 hasPreferredOutpostArns() method.

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

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