Class: Aws::MemoryDB::Types::ClusterConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::MemoryDB::Types::ClusterConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-memorydb/types.rb

Overview

A list of cluster configuration options.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the cluster configuration.

• #engine ⇒ String

  The configuration for the Redis OSS or Valkey engine used by the cluster.

• #engine_version ⇒ String

  The engine version used by the cluster.

• #maintenance_window ⇒ String

  The specified maintenance window for the cluster.

• #name ⇒ String

  The name of the cluster.

• #node_type ⇒ String

  The node type used for the cluster.

• #num_shards ⇒ Integer

  The number of shards in the cluster.

• #parameter_group_name ⇒ String

  The name of parameter group used by the cluster.

• #port ⇒ Integer

  The port used by the cluster.

• #shards ⇒ Array<Types::ShardDetail>

  The list of shards in the cluster.

• #snapshot_retention_limit ⇒ Integer

  The snapshot retention limit set by the cluster.

• #snapshot_window ⇒ String

  The snapshot window set by the cluster.

• #subnet_group_name ⇒ String

  The name of the subnet group used by the cluster.

• #topic_arn ⇒ String

  The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.

• #vpc_id ⇒ String

  The ID of the VPC the cluster belongs to.

Instance Attribute Details

#description ⇒ String

The description of the cluster configuration

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The configuration for the Redis OSS or Valkey engine used by the cluster.

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The engine version used by the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_window ⇒ String

The specified maintenance window for the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#node_type ⇒ String

The node type used for the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#num_shards ⇒ Integer

The number of shards in the cluster

Returns:

• (Integer)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_name ⇒ String

The name of parameter group used by the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port used by the cluster

Returns:

• (Integer)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#shards ⇒ Array<Types::ShardDetail>

The list of shards in the cluster

Returns:

• (Array<Types::ShardDetail>)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limit ⇒ Integer

The snapshot retention limit set by the cluster

Returns:

• (Integer)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_window ⇒ String

The snapshot window set by the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_group_name ⇒ String

The name of the subnet group used by the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arn ⇒ String

The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of the VPC the cluster belongs to

Returns:

• (String)

# File 'lib/aws-sdk-memorydb/types.rb', line 434

class ClusterConfiguration < Struct.new(
  :name,
  :description,
  :node_type,
  :engine,
  :engine_version,
  :maintenance_window,
  :topic_arn,
  :port,
  :parameter_group_name,
  :subnet_group_name,
  :vpc_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_shards,
  :shards)
  SENSITIVE = []
  include Aws::Structure
end