Class: Aws::MemoryDB::Types::Cluster

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

Overview

Contains all of the attributes of a specific cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acl_nameString

The name of the Access Control List associated with this cluster.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) of the cluster.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns:

  • (Boolean)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#availability_modeString

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_endpointTypes::Endpoint

The cluster's configuration endpoint

Returns:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#data_tieringString

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the cluster

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#engine_patch_versionString

The Redis engine patch version used by the cluster

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The Redis engine version used by the cluster

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The ID of the KMS key used to encrypt the cluster

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_windowString

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#node_typeString

The cluster's node type

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_shardsInteger

The number of shards in the cluster

Returns:

  • (Integer)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_nameString

The name of the parameter group used by the cluster

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_statusString

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#pending_updatesTypes::ClusterPendingUpdates

A group of settings that are currently being applied.



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#security_groupsArray<Types::SecurityGroupMembership>

A list of security groups used by the cluster

Returns:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#shardsArray<Types::Shard>

A list of shards that are members of the cluster.

Returns:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limitInteger

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Returns:

  • (Integer)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_windowString

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arnString

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

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_statusString

The SNS topic must be in Active status to receive notifications

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the cluster. For example, Available, Updating, Creating.

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_group_nameString

The name of the subnet group used by the cluster

Returns:

  • (String)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#tls_enabledBoolean

A flag to indicate if In-transit encryption is enabled

Returns:

  • (Boolean)


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 328

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine_version,
  :engine_patch_version,
  :parameter_group_name,
  :parameter_group_status,
  :security_groups,
  :subnet_group_name,
  :tls_enabled,
  :kms_key_id,
  :arn,
  :sns_topic_arn,
  :sns_topic_status,
  :snapshot_retention_limit,
  :maintenance_window,
  :snapshot_window,
  :acl_name,
  :auto_minor_version_upgrade,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end