Class: Aws::MemoryDB::Types::UpdateClusterRequest

Inherits:

Struct

Object
Struct
Aws::MemoryDB::Types::UpdateClusterRequest

show all

Includes:: Structure

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

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#acl_name ⇒ String

The Access Control List that is associated with the cluster.
#cluster_name ⇒ String

The name of the cluster to update.
#description ⇒ String

The description of the cluster to update.
#engine ⇒ String

The name of the engine to be used for the cluster.
#engine_version ⇒ String

The upgraded version of the engine to be run on the nodes.
#ip_discovery ⇒ String

The mechanism for discovering IP addresses for the cluster discovery protocol.
#maintenance_window ⇒ String

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

A valid node type that you want to scale this cluster up or down to.
#parameter_group_name ⇒ String

The name of the parameter group to update.
#replica_configuration ⇒ Types::ReplicaConfigurationRequest

The number of replicas that will reside in each shard.
#security_group_ids ⇒ Array<String>

The SecurityGroupIds to update.
#shard_configuration ⇒ Types::ShardConfigurationRequest

The number of shards in the cluster.
#snapshot_retention_limit ⇒ Integer

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

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

The SNS topic ARN to update.
#sns_topic_status ⇒ String

The status of the Amazon SNS notification topic.

Instance Attribute Details

#acl_name ⇒ `String`

The Access Control List that is associated with the cluster.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ `String`

The name of the cluster to update.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the cluster to update.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The name of the engine to be used for the cluster.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#ip_discovery ⇒ `String`

The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are ‘ipv4’ or ‘ipv6’. When set to ‘ipv4’, cluster discovery functions such as cluster slots, cluster shards, and cluster nodes will return IPv4 addresses for cluster nodes. When set to ‘ipv6’, the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is ‘ipv4’.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  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.

Valid values for ‘ddd` are:

‘sun`
‘mon`
‘tue`
‘wed`
‘thu`
‘fri`
‘sat`

Example: ‘sun:23:00-mon:01:30`

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#node_type ⇒ `String`

A valid node type that you want to scale this cluster up or down to.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_name ⇒ `String`

The name of the parameter group to update.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#replica_configuration ⇒ `Types::ReplicaConfigurationRequest`

The number of replicas that will reside in each shard.

Returns:

(Types::ReplicaConfigurationRequest)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

The SecurityGroupIds to update.

Returns:

(Array<String>)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#shard_configuration ⇒ `Types::ShardConfigurationRequest`

The number of shards in the cluster.

Returns:

(Types::ShardConfigurationRequest)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limit ⇒ `Integer`

The number of days for which MemoryDB retains automatic cluster 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 3839

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_window ⇒ `String`

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ `String`

The SNS topic ARN to update.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_status ⇒ `String`

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Returns:

(String)

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

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :security_group_ids,
  :maintenance_window,
  :sns_topic_arn,
  :sns_topic_status,
  :parameter_group_name,
  :snapshot_window,
  :snapshot_retention_limit,
  :node_type,
  :engine,
  :engine_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name,
  :ip_discovery)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::MemoryDB::Types::UpdateClusterRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#acl_name ⇒ String

#cluster_name ⇒ String

#description ⇒ String

#engine ⇒ String

#engine_version ⇒ String

#ip_discovery ⇒ String

#maintenance_window ⇒ String

#node_type ⇒ String

#parameter_group_name ⇒ String

#replica_configuration ⇒ Types::ReplicaConfigurationRequest

#security_group_ids ⇒ Array<String>

#shard_configuration ⇒ Types::ShardConfigurationRequest

#snapshot_retention_limit ⇒ Integer

#snapshot_window ⇒ String

#sns_topic_arn ⇒ String

#sns_topic_status ⇒ String

#acl_name ⇒ `String`

#cluster_name ⇒ `String`

#description ⇒ `String`

#engine ⇒ `String`

#engine_version ⇒ `String`

#ip_discovery ⇒ `String`

#maintenance_window ⇒ `String`

#node_type ⇒ `String`

#parameter_group_name ⇒ `String`

#replica_configuration ⇒ `Types::ReplicaConfigurationRequest`

#security_group_ids ⇒ `Array<String>`

#shard_configuration ⇒ `Types::ShardConfigurationRequest`

#snapshot_retention_limit ⇒ `Integer`

#snapshot_window ⇒ `String`

#sns_topic_arn ⇒ `String`

#sns_topic_status ⇒ `String`