NodeGroupMember - Amazon ElastiCache
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

NodeGroupMember

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

Contents

Note

In the following list, the required parameters are described first.

CacheClusterId

The ID of the cluster to which the node belongs.

Type: String

Required: No

CacheNodeId

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

Type: String

Required: No

CurrentRole

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

Type: String

Required: No

PreferredAvailabilityZone

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

Type: String

Required: No

PreferredOutpostArn

The outpost ARN of the node group member.

Type: String

Required: No

ReadEndpoint

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

Type: Endpoint object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: