Class: Aws::ElastiCache::Types::NodeGroupConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::ElastiCache::Types::NodeGroupConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass NodeGroupConfiguration data as a hash:

{
  node_group_id: "AllowedNodeGroupId",
  slots: "String",
  replica_count: 1,
  primary_availability_zone: "String",
  replica_availability_zones: ["String"],
  primary_outpost_arn: "String",
  replica_outpost_arns: ["String"],
}

Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #node_group_id ⇒ String

  Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

• #primary_availability_zone ⇒ String

  The Availability Zone where the primary node of this node group (shard) is launched.

• #primary_outpost_arn ⇒ String

  The outpost ARN of the primary node.

• #replica_availability_zones ⇒ Array<String>

  A list of Availability Zones to be used for the read replicas.

• #replica_count ⇒ Integer

  The number of read replica nodes in this node group (shard).

• #replica_outpost_arns ⇒ Array<String>

  The outpost ARN of the node replicas.

• #slots ⇒ String

  A string that specifies the keyspace for a particular node group.

Instance Attribute Details

#node_group_id ⇒ String

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

Returns:

• (String)

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

class NodeGroupConfiguration < Struct.new(
  :node_group_id,
  :slots,
  :replica_count,
  :primary_availability_zone,
  :replica_availability_zones,
  :primary_outpost_arn,
  :replica_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#primary_availability_zone ⇒ String

The Availability Zone where the primary node of this node group (shard) is launched.

Returns:

• (String)

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

class NodeGroupConfiguration < Struct.new(
  :node_group_id,
  :slots,
  :replica_count,
  :primary_availability_zone,
  :replica_availability_zones,
  :primary_outpost_arn,
  :replica_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#primary_outpost_arn ⇒ String

The outpost ARN of the primary node.

Returns:

• (String)

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

class NodeGroupConfiguration < Struct.new(
  :node_group_id,
  :slots,
  :replica_count,
  :primary_availability_zone,
  :replica_availability_zones,
  :primary_outpost_arn,
  :replica_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#replica_availability_zones ⇒ Array<String>

A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

Returns:

• (Array<String>)

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

class NodeGroupConfiguration < Struct.new(
  :node_group_id,
  :slots,
  :replica_count,
  :primary_availability_zone,
  :replica_availability_zones,
  :primary_outpost_arn,
  :replica_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#replica_count ⇒ Integer

The number of read replica nodes in this node group (shard).

Returns:

• (Integer)

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

class NodeGroupConfiguration < Struct.new(
  :node_group_id,
  :slots,
  :replica_count,
  :primary_availability_zone,
  :replica_availability_zones,
  :primary_outpost_arn,
  :replica_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#replica_outpost_arns ⇒ Array<String>

The outpost ARN of the node replicas.

Returns:

• (Array<String>)

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

class NodeGroupConfiguration < Struct.new(
  :node_group_id,
  :slots,
  :replica_count,
  :primary_availability_zone,
  :replica_availability_zones,
  :primary_outpost_arn,
  :replica_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#slots ⇒ String

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

Example: ‘“0-3999”`

Returns:

• (String)

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

class NodeGroupConfiguration < Struct.new(
  :node_group_id,
  :slots,
  :replica_count,
  :primary_availability_zone,
  :replica_availability_zones,
  :primary_outpost_arn,
  :replica_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end