Class: Aws::ElastiCache::Types::NodeGroupMember

Inherits:

Struct

• Object
• Struct
• Aws::ElastiCache::Types::NodeGroupMember

Includes:

Structure

Defined in:

lib/aws-sdk-elasticache/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cache_cluster_id ⇒ String

  The ID of the cluster to which the node belongs.

• #cache_node_id ⇒ String

  The ID of the node within its cluster.

• #current_role ⇒ String

  The role that is currently assigned to the node - ‘primary` or `replica`.

• #preferred_availability_zone ⇒ String

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

• #preferred_outpost_arn ⇒ String

  The outpost ARN of the node group member.

• #read_endpoint ⇒ Types::Endpoint

  The information required for client programs to connect to a node for read operations.

Instance Attribute Details

#cache_cluster_id ⇒ String

The ID of the cluster to which the node belongs.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7000

class NodeGroupMember < Struct.new(
  :cache_cluster_id,
  :cache_node_id,
  :read_endpoint,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :current_role)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7000

class NodeGroupMember < Struct.new(
  :cache_cluster_id,
  :cache_node_id,
  :read_endpoint,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :current_role)
  SENSITIVE = []
  include Aws::Structure
end

#current_role ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7000

class NodeGroupMember < Struct.new(
  :cache_cluster_id,
  :cache_node_id,
  :read_endpoint,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :current_role)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_availability_zone ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7000

class NodeGroupMember < Struct.new(
  :cache_cluster_id,
  :cache_node_id,
  :read_endpoint,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :current_role)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_outpost_arn ⇒ String

The outpost ARN of the node group member.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7000

class NodeGroupMember < Struct.new(
  :cache_cluster_id,
  :cache_node_id,
  :read_endpoint,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :current_role)
  SENSITIVE = []
  include Aws::Structure
end

#read_endpoint ⇒ Types::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.

Returns:

• (Types::Endpoint)

# File 'lib/aws-sdk-elasticache/types.rb', line 7000

class NodeGroupMember < Struct.new(
  :cache_cluster_id,
  :cache_node_id,
  :read_endpoint,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :current_role)
  SENSITIVE = []
  include Aws::Structure
end