@Generated(value="software.amazon.awssdk:codegen") public final class ReplicationGroup extends Object implements 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 |
---|---|
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. |
AutomaticFailoverStatus |
automaticFailover()
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
|
String |
automaticFailoverAsString()
Indicates the status of Multi-AZ with 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<String> |
memberClusters()
The identifiers of all the nodes that are part of this replication group.
|
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.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
transitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true . |
copy
public String replicationGroupId()
The identifier for the replication group.
public String description()
The user supplied description of the replication group.
public String status()
The current state of this replication group - creating
, available
,
modifying
, deleting
, create-failed
, snapshotting
.
creating
, available
,
modifying
, deleting
, create-failed
, snapshotting
.public ReplicationGroupPendingModifiedValues pendingModifiedValues()
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
public List<String> memberClusters()
The identifiers of all the nodes that are part of this replication group.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
public String snapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group.
public AutomaticFailoverStatus automaticFailover()
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
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()
.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
AutomaticFailoverStatus
public String automaticFailoverAsString()
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
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()
.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
AutomaticFailoverStatus
public Endpoint configurationEndpoint()
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
public 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 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 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 String cacheNodeType()
The name of the compute and memory capacity node type for each node in the replication group.
public 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 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.
Default: false
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.
Default: false
public 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.
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.
Default: false
public ReplicationGroup.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ReplicationGroup.Builder,ReplicationGroup>
public static ReplicationGroup.Builder builder()
public static Class<? extends ReplicationGroup.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.