#[non_exhaustive]pub struct ReplicationGroup {Show 32 fields
pub replication_group_id: Option<String>,
pub description: Option<String>,
pub global_replication_group_info: Option<GlobalReplicationGroupInfo>,
pub status: Option<String>,
pub pending_modified_values: Option<ReplicationGroupPendingModifiedValues>,
pub member_clusters: Option<Vec<String>>,
pub node_groups: Option<Vec<NodeGroup>>,
pub snapshotting_cluster_id: Option<String>,
pub automatic_failover: Option<AutomaticFailoverStatus>,
pub multi_az: Option<MultiAzStatus>,
pub configuration_endpoint: Option<Endpoint>,
pub snapshot_retention_limit: Option<i32>,
pub snapshot_window: Option<String>,
pub cluster_enabled: Option<bool>,
pub cache_node_type: Option<String>,
pub auth_token_enabled: Option<bool>,
pub auth_token_last_modified_date: Option<DateTime>,
pub transit_encryption_enabled: Option<bool>,
pub at_rest_encryption_enabled: Option<bool>,
pub member_clusters_outpost_arns: Option<Vec<String>>,
pub kms_key_id: Option<String>,
pub arn: Option<String>,
pub user_group_ids: Option<Vec<String>>,
pub log_delivery_configurations: Option<Vec<LogDeliveryConfiguration>>,
pub replication_group_create_time: Option<DateTime>,
pub data_tiering: Option<DataTieringStatus>,
pub auto_minor_version_upgrade: Option<bool>,
pub network_type: Option<NetworkType>,
pub ip_discovery: Option<IpDiscovery>,
pub transit_encryption_mode: Option<TransitEncryptionMode>,
pub cluster_mode: Option<ClusterMode>,
pub engine: Option<String>,
}Expand description
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.replication_group_id: Option<String>The identifier for the replication group.
description: Option<String>The user supplied description of the replication group.
global_replication_group_info: Option<GlobalReplicationGroupInfo>The name of the Global datastore and role of this replication group in the Global datastore.
status: Option<String>The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
pending_modified_values: Option<ReplicationGroupPendingModifiedValues>A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
member_clusters: Option<Vec<String>>The names of all the cache clusters that are part of this replication group.
node_groups: Option<Vec<NodeGroup>>A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
snapshotting_cluster_id: Option<String>The cluster ID that is used as the daily snapshot source for the replication group.
automatic_failover: Option<AutomaticFailoverStatus>Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
multi_az: Option<MultiAzStatus>A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
configuration_endpoint: Option<Endpoint>The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
snapshot_retention_limit: Option<i32>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.
snapshot_window: Option<String>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.
cluster_enabled: Option<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).
Valid values: true | false
cache_node_type: Option<String>The name of the compute and memory capacity node type for each node in the replication group.
auth_token_enabled: Option<bool>A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
auth_token_last_modified_date: Option<DateTime>The date the auth token was last modified
transit_encryption_enabled: Option<bool>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 OSS version 3.2.6, 4.x or later.
Default: false
at_rest_encryption_enabled: Option<bool>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 OSS version 3.2.6, 4.x or later.
Default: false
member_clusters_outpost_arns: Option<Vec<String>>The outpost ARNs of the replication group's member clusters.
kms_key_id: Option<String>The ID of the KMS key used to encrypt the disk in the cluster.
arn: Option<String>The ARN (Amazon Resource Name) of the replication group.
user_group_ids: Option<Vec<String>>The ID of the user group associated to the replication group.
log_delivery_configurations: Option<Vec<LogDeliveryConfiguration>>Returns the destination, format and type of the logs.
replication_group_create_time: Option<DateTime>The date and time when the cluster was created.
data_tiering: Option<DataTieringStatus>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.
auto_minor_version_upgrade: Option<bool>If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, 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.
network_type: Option<NetworkType>Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
ip_discovery: Option<IpDiscovery>The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
transit_encryption_mode: Option<TransitEncryptionMode>A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
cluster_mode: Option<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 Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
engine: Option<String>The engine used in a replication group. The options are redis, memcached or valkey.
Implementations§
Source§impl ReplicationGroup
impl ReplicationGroup
Sourcepub fn replication_group_id(&self) -> Option<&str>
pub fn replication_group_id(&self) -> Option<&str>
The identifier for the replication group.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The user supplied description of the replication group.
Sourcepub fn global_replication_group_info(
&self,
) -> Option<&GlobalReplicationGroupInfo>
pub fn global_replication_group_info( &self, ) -> Option<&GlobalReplicationGroupInfo>
The name of the Global datastore and role of this replication group in the Global datastore.
Sourcepub fn status(&self) -> Option<&str>
pub fn status(&self) -> Option<&str>
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
Sourcepub fn pending_modified_values(
&self,
) -> Option<&ReplicationGroupPendingModifiedValues>
pub fn pending_modified_values( &self, ) -> Option<&ReplicationGroupPendingModifiedValues>
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
Sourcepub fn member_clusters(&self) -> &[String]
pub fn member_clusters(&self) -> &[String]
The names of all the cache clusters that are part of this replication group.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .member_clusters.is_none().
Sourcepub fn node_groups(&self) -> &[NodeGroup]
pub fn node_groups(&self) -> &[NodeGroup]
A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .node_groups.is_none().
Sourcepub fn snapshotting_cluster_id(&self) -> Option<&str>
pub fn snapshotting_cluster_id(&self) -> Option<&str>
The cluster ID that is used as the daily snapshot source for the replication group.
Sourcepub fn automatic_failover(&self) -> Option<&AutomaticFailoverStatus>
pub fn automatic_failover(&self) -> Option<&AutomaticFailoverStatus>
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Sourcepub fn multi_az(&self) -> Option<&MultiAzStatus>
pub fn multi_az(&self) -> Option<&MultiAzStatus>
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
Sourcepub fn configuration_endpoint(&self) -> Option<&Endpoint>
pub fn configuration_endpoint(&self) -> Option<&Endpoint>
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Sourcepub fn snapshot_retention_limit(&self) -> Option<i32>
pub fn snapshot_retention_limit(&self) -> Option<i32>
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.
Sourcepub fn snapshot_window(&self) -> Option<&str>
pub fn snapshot_window(&self) -> Option<&str>
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.
Sourcepub fn cluster_enabled(&self) -> Option<bool>
pub fn cluster_enabled(&self) -> Option<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).
Valid values: true | false
Sourcepub fn cache_node_type(&self) -> Option<&str>
pub fn cache_node_type(&self) -> Option<&str>
The name of the compute and memory capacity node type for each node in the replication group.
Sourcepub fn auth_token_enabled(&self) -> Option<bool>
pub fn auth_token_enabled(&self) -> Option<bool>
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
Sourcepub fn auth_token_last_modified_date(&self) -> Option<&DateTime>
pub fn auth_token_last_modified_date(&self) -> Option<&DateTime>
The date the auth token was last modified
Sourcepub fn transit_encryption_enabled(&self) -> Option<bool>
pub fn transit_encryption_enabled(&self) -> Option<bool>
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 OSS version 3.2.6, 4.x or later.
Default: false
Sourcepub fn at_rest_encryption_enabled(&self) -> Option<bool>
pub fn at_rest_encryption_enabled(&self) -> Option<bool>
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 OSS version 3.2.6, 4.x or later.
Default: false
Sourcepub fn member_clusters_outpost_arns(&self) -> &[String]
pub fn member_clusters_outpost_arns(&self) -> &[String]
The outpost ARNs of the replication group's member clusters.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .member_clusters_outpost_arns.is_none().
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The ID of the KMS key used to encrypt the disk in the cluster.
Sourcepub fn user_group_ids(&self) -> &[String]
pub fn user_group_ids(&self) -> &[String]
The ID of the user group associated to the replication group.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_group_ids.is_none().
Sourcepub fn log_delivery_configurations(&self) -> &[LogDeliveryConfiguration]
pub fn log_delivery_configurations(&self) -> &[LogDeliveryConfiguration]
Returns the destination, format and type of the logs.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .log_delivery_configurations.is_none().
Sourcepub fn replication_group_create_time(&self) -> Option<&DateTime>
pub fn replication_group_create_time(&self) -> Option<&DateTime>
The date and time when the cluster was created.
Sourcepub fn data_tiering(&self) -> Option<&DataTieringStatus>
pub fn data_tiering(&self) -> Option<&DataTieringStatus>
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.
Sourcepub fn auto_minor_version_upgrade(&self) -> Option<bool>
pub fn auto_minor_version_upgrade(&self) -> Option<bool>
If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, 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.
Sourcepub fn network_type(&self) -> Option<&NetworkType>
pub fn network_type(&self) -> Option<&NetworkType>
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Sourcepub fn ip_discovery(&self) -> Option<&IpDiscovery>
pub fn ip_discovery(&self) -> Option<&IpDiscovery>
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Sourcepub fn transit_encryption_mode(&self) -> Option<&TransitEncryptionMode>
pub fn transit_encryption_mode(&self) -> Option<&TransitEncryptionMode>
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
Sourcepub fn cluster_mode(&self) -> Option<&ClusterMode>
pub fn cluster_mode(&self) -> Option<&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 Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
Source§impl ReplicationGroup
impl ReplicationGroup
Sourcepub fn builder() -> ReplicationGroupBuilder
pub fn builder() -> ReplicationGroupBuilder
Creates a new builder-style object to manufacture ReplicationGroup.
Trait Implementations§
Source§impl Clone for ReplicationGroup
impl Clone for ReplicationGroup
Source§fn clone(&self) -> ReplicationGroup
fn clone(&self) -> ReplicationGroup
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ReplicationGroup
impl Debug for ReplicationGroup
Source§impl PartialEq for ReplicationGroup
impl PartialEq for ReplicationGroup
impl StructuralPartialEq for ReplicationGroup
Auto Trait Implementations§
impl Freeze for ReplicationGroup
impl RefUnwindSafe for ReplicationGroup
impl Send for ReplicationGroup
impl Sync for ReplicationGroup
impl Unpin for ReplicationGroup
impl UnwindSafe for ReplicationGroup
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);