Class: Aws::DAX::Types::UpdateClusterRequest

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

Overview

Note:

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

{
  cluster_name: "String", # required
  description: "String",
  preferred_maintenance_window: "String",
  notification_topic_arn: "String",
  notification_topic_status: "String",
  parameter_group_name: "String",
  security_group_ids: ["String"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_nameString

The name of the DAX cluster to be modified.

Returns:

  • (String)


1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1801

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :notification_topic_status,
  :parameter_group_name,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the changes being made to the cluster.

Returns:

  • (String)


1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1801

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :notification_topic_status,
  :parameter_group_name,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#notification_topic_arnString

The Amazon Resource Name (ARN) that identifies the topic.

Returns:

  • (String)


1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1801

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :notification_topic_status,
  :parameter_group_name,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#notification_topic_statusString

The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

Returns:

  • (String)


1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1801

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :notification_topic_status,
  :parameter_group_name,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group_nameString

The name of a parameter group for this cluster.

Returns:

  • (String)


1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1801

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :notification_topic_status,
  :parameter_group_name,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Returns:

  • (String)


1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1801

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :notification_topic_status,
  :parameter_group_name,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<String>

A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.

Returns:

  • (Array<String>)


1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1801

class UpdateClusterRequest < Struct.new(
  :cluster_name,
  :description,
  :preferred_maintenance_window,
  :notification_topic_arn,
  :notification_topic_status,
  :parameter_group_name,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end