Struct NodeGroupMember

#[non_exhaustive]
pub struct NodeGroupMember {
    pub cache_cluster_id: Option<String>,
    pub cache_node_id: Option<String>,
    pub read_endpoint: Option<Endpoint>,
    pub preferred_availability_zone: Option<String>,
    pub preferred_outpost_arn: Option<String>,
    pub current_role: Option<String>,
}

Represents a single node within a node group (shard).

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

cache_cluster_id: Option<String>

The ID of the cluster to which the node belongs.

cache_node_id: Option<String>

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

read_endpoint: Option<Endpoint>

The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.

preferred_availability_zone: Option<String>

The name of the Availability Zone in which the node is located.

preferred_outpost_arn: Option<String>

The outpost ARN of the node group member.

current_role: Option<String>

The role that is currently assigned to the node - primary or replica. This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.

Implementations

impl NodeGroupMember

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

The ID of the cluster to which the node belongs.

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

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

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

The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.

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

The name of the Availability Zone in which the node is located.

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

The outpost ARN of the node group member.

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

The role that is currently assigned to the node - primary or replica. This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.

impl NodeGroupMember

pub fn builder() -> NodeGroupMemberBuilder

Creates a new builder-style object to manufacture NodeGroupMember.

Trait Implementations

impl Clone for NodeGroupMember

fn clone(&self) -> NodeGroupMember

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeGroupMember

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

Formats the value using the given formatter.

impl PartialEq for NodeGroupMember

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NodeGroupMember