@Generated(value="software.amazon.awssdk:codegen") public final class ReplicationGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>
Contains all of the attributes of a specific Redis replication group.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ReplicationGroup.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arn()
The ARN (Amazon Resource Name) of the replication group.
|
Boolean |
atRestEncryptionEnabled()
A flag that enables encryption at-rest when set to
true. |
Boolean |
authTokenEnabled()
A flag that enables using an
AuthToken (password) when issuing Redis commands. |
Instant |
authTokenLastModifiedDate()
The date the auth token was last modified
|
AutomaticFailoverStatus |
automaticFailover()
Indicates the status of automatic failover for this Redis replication group.
|
String |
automaticFailoverAsString()
Indicates the status of automatic failover for this Redis replication group.
|
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.
|
static ReplicationGroup.Builder |
builder() |
String |
cacheNodeType()
The name of the compute and memory capacity node type for each node in the replication group.
|
Boolean |
clusterEnabled()
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).
|
ClusterMode |
clusterMode()
Enabled or Disabled.
|
String |
clusterModeAsString()
Enabled or Disabled.
|
Endpoint |
configurationEndpoint()
The configuration endpoint for this replication group.
|
DataTieringStatus |
dataTiering()
Enables data tiering.
|
String |
dataTieringAsString()
Enables data tiering.
|
String |
description()
The user supplied description of the replication group.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
GlobalReplicationGroupInfo |
globalReplicationGroupInfo()
The name of the Global datastore and role of this replication group in the Global datastore.
|
int |
hashCode() |
boolean |
hasLogDeliveryConfigurations()
For responses, this returns true if the service returned a value for the LogDeliveryConfigurations property.
|
boolean |
hasMemberClusters()
For responses, this returns true if the service returned a value for the MemberClusters property.
|
boolean |
hasMemberClustersOutpostArns()
For responses, this returns true if the service returned a value for the MemberClustersOutpostArns property.
|
boolean |
hasNodeGroups()
For responses, this returns true if the service returned a value for the NodeGroups property.
|
boolean |
hasUserGroupIds()
For responses, this returns true if the service returned a value for the UserGroupIds property.
|
IpDiscovery |
ipDiscovery()
The network type you choose when modifying a cluster, either
ipv4 | ipv6. |
String |
ipDiscoveryAsString()
The network type you choose when modifying a cluster, either
ipv4 | ipv6. |
String |
kmsKeyId()
The ID of the KMS key used to encrypt the disk in the cluster.
|
List<LogDeliveryConfiguration> |
logDeliveryConfigurations()
Returns the destination, format and type of the logs.
|
List<String> |
memberClusters()
The names of all the cache clusters that are part of this replication group.
|
List<String> |
memberClustersOutpostArns()
The outpost ARNs of the replication group's member clusters.
|
MultiAZStatus |
multiAZ()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
String |
multiAZAsString()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
NetworkType |
networkType()
Must be either
ipv4 | ipv6 | dual_stack. |
String |
networkTypeAsString()
Must be either
ipv4 | ipv6 | dual_stack. |
List<NodeGroup> |
nodeGroups()
A list of node groups in this replication group.
|
ReplicationGroupPendingModifiedValues |
pendingModifiedValues()
A group of settings to be applied to the replication group, either immediately or during the next maintenance
window.
|
Instant |
replicationGroupCreateTime()
The date and time when the cluster was created.
|
String |
replicationGroupId()
The identifier for the replication group.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ReplicationGroup.Builder> |
serializableBuilderClass() |
Integer |
snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
String |
snapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group.
|
String |
snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
String |
status()
The current state of this replication group -
creating, available,
modifying, deleting, create-failed, snapshotting. |
ReplicationGroup.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
transitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true. |
TransitEncryptionMode |
transitEncryptionMode()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
|
String |
transitEncryptionModeAsString()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
|
List<String> |
userGroupIds()
The ID of the user group associated to the replication group.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String replicationGroupId()
The identifier for the replication group.
public final String description()
The user supplied description of the replication group.
public final GlobalReplicationGroupInfo globalReplicationGroupInfo()
The name of the Global datastore and role of this replication group in the Global datastore.
public final String status()
The current state of this replication group - creating, available,
modifying, deleting, create-failed, snapshotting.
creating, available,
modifying, deleting, create-failed, snapshotting.public final ReplicationGroupPendingModifiedValues pendingModifiedValues()
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
public final boolean hasMemberClusters()
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.public final List<String> memberClusters()
The names of all the cache clusters that are part of this replication group.
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 hasMemberClusters() method.
public final boolean hasNodeGroups()
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.public final List<NodeGroup> nodeGroups()
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).
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 hasNodeGroups() method.
public final String snapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group.
public final AutomaticFailoverStatus automaticFailover()
Indicates the status of automatic failover for this Redis replication group.
If the service returns an enum value that is not available in the current SDK version, automaticFailover
will return AutomaticFailoverStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from automaticFailoverAsString().
AutomaticFailoverStatuspublic final String automaticFailoverAsString()
Indicates the status of automatic failover for this Redis replication group.
If the service returns an enum value that is not available in the current SDK version, automaticFailover
will return AutomaticFailoverStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is
available from automaticFailoverAsString().
AutomaticFailoverStatuspublic final MultiAZStatus multiAZ()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
If the service returns an enum value that is not available in the current SDK version, multiAZ will
return MultiAZStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
multiAZAsString().
MultiAZStatuspublic final String multiAZAsString()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
If the service returns an enum value that is not available in the current SDK version, multiAZ will
return MultiAZStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
multiAZAsString().
MultiAZStatuspublic final Endpoint configurationEndpoint()
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
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.
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.
public final String snapshotWindow()
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.
This parameter is only valid if the Engine parameter is redis.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine parameter is redis.
public final Boolean clusterEnabled()
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
Valid values: true | false
public final String cacheNodeType()
The name of the compute and memory capacity node type for each node in the replication group.
public final Boolean authTokenEnabled()
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
AuthToken (password) when issuing Redis commands.
Default: false
public final Instant authTokenLastModifiedDate()
The date the auth token was last modified
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
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
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
encryption at-rest 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
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.
Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6, 4.x or later.
Default: false
public final boolean hasMemberClustersOutpostArns()
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.public final List<String> memberClustersOutpostArns()
The outpost ARNs of the replication group's member clusters.
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 hasMemberClustersOutpostArns() method.
public final String kmsKeyId()
The ID of the KMS key used to encrypt the disk in the cluster.
public final String arn()
The ARN (Amazon Resource Name) of the replication group.
public final boolean hasUserGroupIds()
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.public final List<String> userGroupIds()
The ID of the user group associated to the replication group.
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 hasUserGroupIds() method.
public final boolean hasLogDeliveryConfigurations()
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.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.
public final Instant replicationGroupCreateTime()
The date and time when the cluster was created.
public final DataTieringStatus dataTiering()
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
If the service returns an enum value that is not available in the current SDK version, dataTiering will
return DataTieringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
dataTieringAsString().
DataTieringStatuspublic final String dataTieringAsString()
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
If the service returns an enum value that is not available in the current SDK version, dataTiering will
return DataTieringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
dataTieringAsString().
DataTieringStatuspublic 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.
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().
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.NetworkTypepublic 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().
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.NetworkTypepublic final IpDiscovery ipDiscovery()
The network type you choose when modifying a 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().
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.IpDiscoverypublic final String ipDiscoveryAsString()
The network type you choose when modifying a 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().
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.IpDiscoverypublic final TransitEncryptionMode transitEncryptionMode()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
If the service returns an enum value that is not available in the current SDK version,
transitEncryptionMode will return TransitEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from transitEncryptionModeAsString().
TransitEncryptionModepublic final String transitEncryptionModeAsString()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
If the service returns an enum value that is not available in the current SDK version,
transitEncryptionMode will return TransitEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from transitEncryptionModeAsString().
TransitEncryptionModepublic final ClusterMode clusterMode()
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
If the service returns an enum value that is not available in the current SDK version, clusterMode will
return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
clusterModeAsString().
ClusterModepublic final String clusterModeAsString()
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
If the service returns an enum value that is not available in the current SDK version, clusterMode will
return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
clusterModeAsString().
ClusterModepublic ReplicationGroup.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>public static ReplicationGroup.Builder builder()
public static Class<? extends ReplicationGroup.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.