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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_nodes ⇒ Integer

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

Returns:

  • (Integer) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arn ⇒ String

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

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_discovery_endpoint ⇒ Types::Endpoint

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_endpoint_encryption_type ⇒ String

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name of the DAX cluster.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the cluster.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

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) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

The IP address type of the cluster. Values are:

  • ipv4 - IPv4 addresses only

  • ipv6 - IPv6 addresses only

  • dual_stack - Both IPv4 and IPv6 addresses

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#node_ids_to_remove ⇒ Array<String>

A list of nodes to be removed from the cluster.

Returns:

  • (Array<String>) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#node_type ⇒ String

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

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#nodes ⇒ Array<Types::Node>

A list of nodes that are currently in the cluster.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#notification_configuration ⇒ Types::NotificationConfiguration

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

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_group ⇒ Types::ParameterGroupStatus

The parameter group being used by nodes in the cluster.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

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) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ Array<Types::SecurityGroupMembership>

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

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#sse_description ⇒ Types::SSEDescription

The description of the server-side encryption status on the specified DAX cluster.

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the cluster.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_group ⇒ String

The subnet group where the DAX cluster is running.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#total_nodes ⇒ Integer

The total number of nodes in the cluster.

Returns:

  • (Integer) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 117

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,
  :sse_description,
  :cluster_endpoint_encryption_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end