AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#node_group_idString

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)


6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6411

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_zoneString

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

Returns:

  • (String)


6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6411

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_arnString

The output ARN of the primary node.

Returns:

  • (String)


6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6411

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_zonesArray<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>)


6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6411

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_countInteger

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

Returns:

  • (Integer)


6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6411

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_arnsArray<String>

The outpost ARN of the node replicas.

Returns:

  • (Array<String>)


6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6411

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

#slotsString

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)


6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6411

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