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

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

Overview

Note:

When making an API call, you may pass UpdateClusterRequest data as a hash:

{
  cluster_name: "String", # required
  description: "String",
  security_group_ids: ["String"],
  maintenance_window: "String",
  sns_topic_arn: "String",
  sns_topic_status: "String",
  parameter_group_name: "String",
  snapshot_window: "String",
  snapshot_retention_limit: 1,
  node_type: "String",
  engine_version: "String",
  replica_configuration: {
    replica_count: 1,
  },
  shard_configuration: {
    shard_count: 1,
  },
  acl_name: "ACLName",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acl_nameString

The Access Control List that is associated with the cluster

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nameString

The name of the cluster to update

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the cluster to update

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

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)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_windowString

The maintenance window to update

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#node_typeString

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

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_nameString

The name of the parameter group to update

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#replica_configurationTypes::ReplicaConfigurationRequest

The number of replicas that will reside in each shard



3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<String>

The SecurityGroupIds to update

Returns:

  • (Array<String>)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#shard_configurationTypes::ShardConfigurationRequest

The number of shards in the cluster



3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limitInteger

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)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_windowString

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

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arnString

The SNS topic ARN to update

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_statusString

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

Returns:

  • (String)


3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/types.rb', line 3144

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_version,
  :replica_configuration,
  :shard_configuration,
  :acl_name)
  SENSITIVE = []
  include Aws::Structure
end