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

Inherits:

Struct

Object
Struct
Aws::MemoryDB::Types::Cluster

show all

Includes:: Structure

Defined in:: lib/aws-sdk-memorydb/types.rb

Overview

Contains all of the attributes of a specific cluster.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#acl_name ⇒ String

The name of the Access Control List associated with this cluster.
#arn ⇒ String

The Amazon Resource Name (ARN) of the cluster.
#auto_minor_version_upgrade ⇒ Boolean

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

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
#cluster_endpoint ⇒ Types::Endpoint

The cluster’s configuration endpoint.
#data_tiering ⇒ String

Enables data tiering.
#description ⇒ String

A description of the cluster.
#engine ⇒ String

The name of the engine used by the cluster.
#engine_patch_version ⇒ String

The Redis OSS engine patch version used by the cluster.
#engine_version ⇒ String

The Redis OSS engine version used by the cluster.
#kms_key_id ⇒ String

The ID of the KMS key used to encrypt the cluster.
#maintenance_window ⇒ String

Specifies the weekly time range during which maintenance on the cluster is performed.
#multi_region_cluster_name ⇒ String

The name of the multi-Region cluster that this cluster belongs to.
#name ⇒ String

The user-supplied name of the cluster.
#node_type ⇒ String

The cluster’s node type.
#number_of_shards ⇒ Integer

The number of shards in the cluster.
#parameter_group_name ⇒ String

The name of the parameter group used by the cluster.
#parameter_group_status ⇒ String

The status of the parameter group used by the cluster, for example ‘active’ or ‘applying’.
#pending_updates ⇒ Types::ClusterPendingUpdates

A group of settings that are currently being applied.
#security_groups ⇒ Array<Types::SecurityGroupMembership>

A list of security groups used by the cluster.
#shards ⇒ Array<Types::Shard>

A list of shards that are members of the cluster.
#snapshot_retention_limit ⇒ Integer

The number of days for which MemoryDB retains automatic snapshots before deleting them.
#snapshot_window ⇒ String

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
#sns_topic_arn ⇒ String

The Amazon Resource Name (ARN) of the SNS notification topic.
#sns_topic_status ⇒ String

The SNS topic must be in Active status to receive notifications.
#status ⇒ String

The status of the cluster.
#subnet_group_name ⇒ String

The name of the subnet group used by the cluster.
#tls_enabled ⇒ Boolean

A flag to indicate if In-transit encryption is enabled.

Instance Attribute Details

#acl_name ⇒ `String`

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

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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

#arn ⇒ `String`

The Amazon Resource Name (ARN) of the cluster.

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_upgrade ⇒ `Boolean`

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

Returns:

(Boolean)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_mode ⇒ `String`

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

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_endpoint ⇒ `Types::Endpoint`

The cluster’s configuration endpoint

Returns:

(Types::Endpoint)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_tiering ⇒ `String`

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].

[1]: docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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

#description ⇒ `String`

A description of the cluster

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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 ⇒ `String`

The name of the engine used by the cluster.

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_version ⇒ `String`

The Redis OSS engine patch version used by the cluster

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_version ⇒ `String`

The Redis OSS engine version used by the cluster

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_id ⇒ `String`

The ID of the KMS key used to encrypt the cluster

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_window ⇒ `String`

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)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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

#multi_region_cluster_name ⇒ `String`

The name of the multi-Region cluster that this cluster belongs to.

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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

#name ⇒ `String`

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

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_type ⇒ `String`

The cluster’s node type

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_shards ⇒ `Integer`

The number of shards in the cluster

Returns:

(Integer)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_name ⇒ `String`

The name of the parameter group used by the cluster

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_status ⇒ `String`

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

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_updates ⇒ `Types::ClusterPendingUpdates`

A group of settings that are currently being applied.

Returns:

(Types::ClusterPendingUpdates)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_groups ⇒ `Array<Types::SecurityGroupMembership>`

A list of security groups used by the cluster

Returns:

(Array<Types::SecurityGroupMembership>)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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

#shards ⇒ `Array<Types::Shard>`

A list of shards that are members of the cluster.

Returns:

(Array<Types::Shard>)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_limit ⇒ `Integer`

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)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_window ⇒ `String`

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)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_arn ⇒ `String`

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

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_status ⇒ `String`

The SNS topic must be in Active status to receive notifications

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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

#status ⇒ `String`

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

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_name ⇒ `String`

The name of the subnet group used by the cluster

Returns:

(String)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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_enabled ⇒ `Boolean`

A flag to indicate if In-transit encryption is enabled

Returns:

(Boolean)

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

class Cluster < Struct.new(
  :name,
  :description,
  :status,
  :pending_updates,
  :multi_region_cluster_name,
  :number_of_shards,
  :shards,
  :availability_mode,
  :cluster_endpoint,
  :node_type,
  :engine,
  :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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#acl_name ⇒ String

#arn ⇒ String

#auto_minor_version_upgrade ⇒ Boolean

#availability_mode ⇒ String

#cluster_endpoint ⇒ Types::Endpoint

#data_tiering ⇒ String

#description ⇒ String

#engine ⇒ String

#engine_patch_version ⇒ String

#engine_version ⇒ String

#kms_key_id ⇒ String

#maintenance_window ⇒ String

#multi_region_cluster_name ⇒ String

#name ⇒ String

#node_type ⇒ String

#number_of_shards ⇒ Integer

#parameter_group_name ⇒ String

#parameter_group_status ⇒ String

#pending_updates ⇒ Types::ClusterPendingUpdates

#security_groups ⇒ Array<Types::SecurityGroupMembership>

#shards ⇒ Array<Types::Shard>

#snapshot_retention_limit ⇒ Integer

#snapshot_window ⇒ String

#sns_topic_arn ⇒ String

#sns_topic_status ⇒ String

#status ⇒ String

#subnet_group_name ⇒ String

#tls_enabled ⇒ Boolean

#acl_name ⇒ `String`

#arn ⇒ `String`

#auto_minor_version_upgrade ⇒ `Boolean`

#availability_mode ⇒ `String`

#cluster_endpoint ⇒ `Types::Endpoint`

#data_tiering ⇒ `String`

#description ⇒ `String`

#engine ⇒ `String`

#engine_patch_version ⇒ `String`

#engine_version ⇒ `String`

#kms_key_id ⇒ `String`

#maintenance_window ⇒ `String`

#multi_region_cluster_name ⇒ `String`

#name ⇒ `String`

#node_type ⇒ `String`

#number_of_shards ⇒ `Integer`

#parameter_group_name ⇒ `String`

#parameter_group_status ⇒ `String`

#pending_updates ⇒ `Types::ClusterPendingUpdates`

#security_groups ⇒ `Array<Types::SecurityGroupMembership>`

#shards ⇒ `Array<Types::Shard>`

#snapshot_retention_limit ⇒ `Integer`

#snapshot_window ⇒ `String`

#sns_topic_arn ⇒ `String`

#sns_topic_status ⇒ `String`

#status ⇒ `String`

#subnet_group_name ⇒ `String`

#tls_enabled ⇒ `Boolean`