You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DAX::Types::Cluster

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

Overview

Contains all of the attributes of a specific DAX cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#active_nodesInteger

The number of nodes in the cluster that are active (i.e., capable of serving requests).

Returns:

  • (Integer)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#cluster_arnString

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#cluster_discovery_endpointTypes::Endpoint

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#cluster_nameString

The name of the DAX cluster.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#descriptionString

The description of the cluster.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#iam_role_arnString

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#node_ids_to_removeArray<String>

A list of nodes to be removed from the cluster.

Returns:

  • (Array<String>)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#node_typeString

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#nodesArray<Types::Node>

A list of nodes that are currently in the cluster.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#notification_configurationTypes::NotificationConfiguration

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#parameter_groupTypes::ParameterGroupStatus

The parameter group being used by nodes in the cluster.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  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)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#security_groupsArray<Types::SecurityGroupMembership>

A list of security groups, and the status of each, for the nodes in the cluster.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#statusString

The current status of the cluster.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#subnet_groupString

The subnet group where the DAX cluster is running.

Returns:

  • (String)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end

#total_nodesInteger

The total number of nodes in the cluster.

Returns:

  • (Integer)


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 93

class Cluster < Struct.new(
  :cluster_name,
  :description,
  :cluster_arn,
  :total_nodes,
  :active_nodes,
  :node_type,
  :status,
  :cluster_discovery_endpoint,
  :node_ids_to_remove,
  :nodes,
  :preferred_maintenance_window,
  :notification_configuration,
  :subnet_group,
  :security_groups,
  :iam_role_arn,
  :parameter_group)
  include Aws::Structure
end