ReplicationGroup class
Contains all of the attributes of a specific Redis replication group.
Constructors
-
ReplicationGroup({String? arn, bool? atRestEncryptionEnabled, bool? authTokenEnabled, DateTime? authTokenLastModifiedDate, AutomaticFailoverStatus? automaticFailover, String? cacheNodeType, bool? clusterEnabled, Endpoint? configurationEndpoint, String? description, GlobalReplicationGroupInfo? globalReplicationGroupInfo, String? kmsKeyId, List<
String> ? memberClusters, List<String> ? memberClustersOutpostArns, MultiAZStatus? multiAZ, List<NodeGroup> ? nodeGroups, ReplicationGroupPendingModifiedValues? pendingModifiedValues, String? replicationGroupId, int? snapshotRetentionLimit, String? snapshotWindow, String? snapshottingClusterId, String? status, bool? transitEncryptionEnabled, List<String> ? userGroupIds}) - ReplicationGroup.fromXml(XmlElement elem)
-
factory
Properties
- arn → String?
-
The ARN (Amazon Resource Name) of the replication group.
final
- atRestEncryptionEnabled → bool?
-
A flag that enables encryption at-rest when set to
true.final - authTokenEnabled → bool?
-
A flag that enables using an
AuthToken(password) when issuing Redis commands.final - authTokenLastModifiedDate → DateTime?
-
The date the auth token was last modified
final
- automaticFailover → AutomaticFailoverStatus?
-
Indicates the status of automatic failover for this Redis replication group.
final
- cacheNodeType → String?
-
The name of the compute and memory capacity node type for each node in the
replication group.
final
- clusterEnabled → bool?
-
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).
final
- configurationEndpoint → Endpoint?
-
The configuration endpoint for this replication group. Use the configuration
endpoint to connect to this replication group.
final
- description → String?
-
The user supplied description of the replication group.
final
- globalReplicationGroupInfo → GlobalReplicationGroupInfo?
-
The name of the Global Datastore and role of this replication group in the
Global Datastore.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- kmsKeyId → String?
-
The ID of the KMS key used to encrypt the disk in the cluster.
final
-
memberClusters
→ List<
String> ? -
The names of all the cache clusters that are part of this replication group.
final
-
memberClustersOutpostArns
→ List<
String> ? -
The outpost ARNs of the replication group's member clusters.
final
- multiAZ → MultiAZStatus?
-
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
For more information, see Minimizing
Downtime: Multi-AZ
final
-
nodeGroups
→ List<
NodeGroup> ? -
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).
final
- pendingModifiedValues → ReplicationGroupPendingModifiedValues?
-
A group of settings to be applied to the replication group, either
immediately or during the next maintenance window.
final
- replicationGroupId → String?
-
The identifier for the replication group.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- snapshotRetentionLimit → int?
-
The number of days for which ElastiCache retains automatic cluster snapshots
before deleting them. For example, if you set
SnapshotRetentionLimitto 5, a snapshot that was taken today is retained for 5 days before being deleted.final - snapshottingClusterId → String?
-
The cluster ID that is used as the daily snapshot source for the replication
group.
final
- snapshotWindow → String?
-
The daily time range (in UTC) during which ElastiCache begins taking a daily
snapshot of your node group (shard).
final
- status → String?
-
The current state of this replication group -
creating,available,modifying,deleting,create-failed,snapshotting.final - transitEncryptionEnabled → bool?
-
A flag that enables in-transit encryption when set to
true.final -
userGroupIds
→ List<
String> ? -
The list of user group IDs that have access to the replication group.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited