ReplicationGroup (AWS Java SDK :: Services :: Amazon ElastiCache 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.services.elasticache.model.ReplicationGroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>

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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReplicationGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReplicationGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`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).
`Endpoint`	`configurationEndpoint()` The configuration endpoint for this replication group.
`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()` Returns true if the LogDeliveryConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasMemberClusters()` Returns true if the MemberClusters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasMemberClustersOutpostArns()` Returns true if the MemberClustersOutpostArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNodeGroups()` Returns true if the NodeGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserGroupIds()` Returns true if the UserGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`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.
`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`.
`List<String>`	`userGroupIds()` The list of user group IDs that have access to the replication group.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - replicationGroupId
```
public final String replicationGroupId()
```
    The identifier for the replication group.
    
    Returns:
    
    The identifier for the replication group.
  - description
```
public final String description()
```
    The user supplied description of the replication group.
    
    Returns:
    
    The user supplied description of the replication group.
  - globalReplicationGroupInfo
```
public final GlobalReplicationGroupInfo globalReplicationGroupInfo()
```
    The name of the Global datastore and role of this replication group in the Global datastore.
    
    Returns:
    
    The name of the Global datastore and role of this replication group in the Global datastore.
  - status
```
public final String status()
```
    The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
    
    Returns:
    
    The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
  - pendingModifiedValues
```
public final ReplicationGroupPendingModifiedValues pendingModifiedValues()
```
    A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
    
    Returns:
    
    A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
  - hasMemberClusters
```
public final boolean hasMemberClusters()
```
    Returns true if the MemberClusters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - memberClusters
```
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.
    
    You can use hasMemberClusters() to see if a value was sent in this field.
    
    Returns:
    
    The names of all the cache clusters that are part of this replication group.
  - hasNodeGroups
```
public final boolean hasNodeGroups()
```
    Returns true if the NodeGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - nodeGroups
```
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.
    
    You can use hasNodeGroups() to see if a value was sent in this field.
    
    Returns:
    
    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).
  - snapshottingClusterId
```
public final String snapshottingClusterId()
```
    The cluster ID that is used as the daily snapshot source for the replication group.
    
    Returns:
    
    The cluster ID that is used as the daily snapshot source for the replication group.
  - automaticFailover
```
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().
    
    Returns:
    
    Indicates the status of automatic failover for this Redis replication group.
    
    See Also:
    
    AutomaticFailoverStatus
  - automaticFailoverAsString
```
public 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().
    
    Returns:
    
    Indicates the status of automatic failover for this Redis replication group.
    
    See Also:
    
    AutomaticFailoverStatus
  - multiAZ
```
public 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().
    
    Returns:
    
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
    
    See Also:
    
    MultiAZStatus
  - multiAZAsString
```
public 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().
    
    Returns:
    
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
    
    See Also:
    
    MultiAZStatus
  - configurationEndpoint
```
public final Endpoint configurationEndpoint()
```
    The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
    
    Returns:
    
    The configuration endpoint for this replication group. Use the configuration endpoint to connect to this 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 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.
    
    Returns:
    
    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.
  - clusterEnabled
```
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
    
    Returns:
    
    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
  - cacheNodeType
```
public final String cacheNodeType()
```
    The name of the compute and memory capacity node type for each node in the replication group.
    
    Returns:
    
    The name of the compute and memory capacity node type for each node in the replication group.
  - 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.
    
    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled 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 in-transit encryption when set to true.
    
    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled 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
  - 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 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
    
    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 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
  - hasMemberClustersOutpostArns
```
public final boolean hasMemberClustersOutpostArns()
```
    Returns true if the MemberClustersOutpostArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - memberClustersOutpostArns
```
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.
    
    You can use hasMemberClustersOutpostArns() to see if a value was sent in this field.
    
    Returns:
    
    The outpost ARNs of the replication group's member clusters.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ID of the KMS key used to encrypt the disk in the cluster.
    
    Returns:
    
    The ID of the KMS key used to encrypt the disk in the cluster.
  - arn
```
public final String arn()
```
    The ARN (Amazon Resource Name) of the replication group.
    
    Returns:
    
    The ARN (Amazon Resource Name) of the replication group.
  - hasUserGroupIds
```
public final boolean hasUserGroupIds()
```
    Returns true if the UserGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userGroupIds
```
public final List<String> userGroupIds()
```
    The list of user group IDs that have access to the replication group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    The list of user group IDs that have access to the replication group.
  - hasLogDeliveryConfigurations
```
public final boolean hasLogDeliveryConfigurations()
```
    Returns true if the LogDeliveryConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasLogDeliveryConfigurations() to see if a value was sent in this field.
    
    Returns:
    
    Returns the destination, format and type of the logs.
  - toBuilder
```
public ReplicationGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>
  - builder
```
public static ReplicationGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReplicationGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ReplicationGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

replicationGroupId

description

globalReplicationGroupInfo

status

pendingModifiedValues

hasMemberClusters

memberClusters

hasNodeGroups

nodeGroups

snapshottingClusterId

automaticFailover

automaticFailoverAsString

multiAZ

multiAZAsString

configurationEndpoint

snapshotRetentionLimit

snapshotWindow

clusterEnabled

cacheNodeType

authTokenEnabled

authTokenLastModifiedDate

transitEncryptionEnabled

atRestEncryptionEnabled

hasMemberClustersOutpostArns

memberClustersOutpostArns

kmsKeyId

arn

hasUserGroupIds

userGroupIds

hasLogDeliveryConfigurations

logDeliveryConfigurations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields