Struct aws_sdk_elasticache::model::ReplicationGroup

source · [−]

#[non_exhaustive]
pub struct ReplicationGroup {Show 26 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>,
}

Expand description

Contains all of the attributes of a specific Redis replication group.

Fields (Non-exhaustive)

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 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).

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

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

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

Struct aws_sdk_elasticache::model::ReplicationGroup

Fields (Non-exhaustive)

Implementations

impl ReplicationGroup

pub fn replication_group_id(&self) -> Option<&str>

pub fn description(&self) -> Option<&str>

pub fn global_replication_group_info( &self) -> Option<&GlobalReplicationGroupInfo>

pub fn status(&self) -> Option<&str>

pub fn pending_modified_values( &self) -> Option<&ReplicationGroupPendingModifiedValues>

pub fn member_clusters(&self) -> Option<&[String]>

pub fn node_groups(&self) -> Option<&[NodeGroup]>

pub fn snapshotting_cluster_id(&self) -> Option<&str>

pub fn automatic_failover(&self) -> Option<&AutomaticFailoverStatus>

pub fn multi_az(&self) -> Option<&MultiAzStatus>

pub fn configuration_endpoint(&self) -> Option<&Endpoint>

pub fn snapshot_retention_limit(&self) -> Option<i32>

pub fn snapshot_window(&self) -> Option<&str>

pub fn cluster_enabled(&self) -> Option<bool>

pub fn cache_node_type(&self) -> Option<&str>

pub fn auth_token_enabled(&self) -> Option<bool>

pub fn auth_token_last_modified_date(&self) -> Option<&DateTime>

pub fn transit_encryption_enabled(&self) -> Option<bool>

pub fn at_rest_encryption_enabled(&self) -> Option<bool>

pub fn member_clusters_outpost_arns(&self) -> Option<&[String]>

pub fn kms_key_id(&self) -> Option<&str>

pub fn arn(&self) -> Option<&str>

pub fn user_group_ids(&self) -> Option<&[String]>

pub fn log_delivery_configurations(&self) -> Option<&[LogDeliveryConfiguration]>

pub fn replication_group_create_time(&self) -> Option<&DateTime>

pub fn data_tiering(&self) -> Option<&DataTieringStatus>

impl ReplicationGroup

pub fn builder() -> Builder

Trait Implementations

impl Clone for ReplicationGroup

fn clone(&self) -> ReplicationGroup

fn clone_from(&mut self, source: &Self)

impl Debug for ReplicationGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq<ReplicationGroup> for ReplicationGroup

fn eq(&self, other: &ReplicationGroup) -> bool

fn ne(&self, other: &ReplicationGroup) -> bool

impl StructuralPartialEq for ReplicationGroup

Auto Trait Implementations

impl RefUnwindSafe for ReplicationGroup

impl Send for ReplicationGroup

impl Sync for ReplicationGroup

impl Unpin for ReplicationGroup

impl UnwindSafe for ReplicationGroup

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn global_replication_group_info(
&self
) -> Option<&GlobalReplicationGroupInfo>

pub fn pending_modified_values(
&self
) -> Option<&ReplicationGroupPendingModifiedValues>

pub fn member_clusters(&self) -> Option<&[String ]>

pub fn node_groups(&self) -> Option<&[NodeGroup ]>

pub fn member_clusters_outpost_arns(&self) -> Option<&[String ]>

pub fn user_group_ids(&self) -> Option<&[String ]>

pub fn log_delivery_configurations(&self) -> Option<&[LogDeliveryConfiguration ]>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,