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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb

Overview

A list of cluster configuration options.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the cluster configuration

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

The name of the engine used by the cluster configuration.

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The Redis OSS engine version used by the cluster

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_windowString

The specified maintenance window for the cluster

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_cluster_nameString

The name for the multi-Region cluster associated with the cluster configuration.

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_parameter_group_nameString

The name of the multi-Region parameter group associated with the cluster configuration.

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the cluster

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#node_typeString

The node type used for the cluster

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#num_shardsInteger

The number of shards in the cluster

Returns:

  • (Integer)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_nameString

The name of parameter group used by the cluster

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The port used by the cluster

Returns:

  • (Integer)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#shardsArray<Types::ShardDetail>

The list of shards in the cluster

Returns:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limitInteger

The snapshot retention limit set by the cluster

Returns:

  • (Integer)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_windowString

The snapshot window set by the cluster

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_group_nameString

The name of the subnet group used by the cluster

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arnString

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

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

The ID of the VPC the cluster belongs to

Returns:

  • (String)


448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 448

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,
  :multi_region_parameter_group_name,
  :multi_region_cluster_name)
  SENSITIVE = []
  include Aws::Structure
end