Class: Aws::DAX::Types::Cluster
- Inherits:
-
Struct
- Object
- Struct
- Aws::DAX::Types::Cluster
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-dax/types.rb
Overview
Contains all of the attributes of a specific DAX cluster.
Instance Attribute Summary collapse
-
#active_nodes ⇒ Integer
The number of nodes in the cluster that are active (i.e., capable of serving requests).
-
#cluster_arn ⇒ String
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
-
#cluster_discovery_endpoint ⇒ Types::Endpoint
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number.
-
#cluster_name ⇒ String
The name of the DAX cluster.
-
#description ⇒ String
The description of the cluster.
-
#iam_role_arn ⇒ String
A valid Amazon Resource Name (ARN) that identifies an IAM role.
-
#node_ids_to_remove ⇒ Array<String>
A list of nodes to be removed from the cluster.
-
#node_type ⇒ String
The node type for the nodes in the cluster.
-
#nodes ⇒ Array<Types::Node>
A list of nodes that are currently in the cluster.
-
#notification_configuration ⇒ Types::NotificationConfiguration
Describes a notification topic and its status.
-
#parameter_group ⇒ Types::ParameterGroupStatus
The parameter group being used by nodes in the cluster.
-
#preferred_maintenance_window ⇒ String
A range of time when maintenance of DAX cluster software will be performed.
-
#security_groups ⇒ Array<Types::SecurityGroupMembership>
A list of security groups, and the status of each, for the nodes in the cluster.
-
#sse_description ⇒ Types::SSEDescription
The description of the server-side encryption status on the specified DAX cluster.
-
#status ⇒ String
The current status of the cluster.
-
#subnet_group ⇒ String
The subnet group where the DAX cluster is running.
-
#total_nodes ⇒ Integer
The total number of nodes in the cluster.
Instance Attribute Details
#active_nodes ⇒ Integer
The number of nodes in the cluster that are active (i.e., capable of serving requests).
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#cluster_arn ⇒ String
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#cluster_discovery_endpoint ⇒ Types::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.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#cluster_name ⇒ String
The name of the DAX cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#description ⇒ String
The description of the cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) 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.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#node_ids_to_remove ⇒ Array<String>
A list of nodes to be removed from the cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) 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.)
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#nodes ⇒ Array<Types::Node>
A list of nodes that are currently in the cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) 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).
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#parameter_group ⇒ Types::ParameterGroupStatus
The parameter group being used by nodes in the cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) 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.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) 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.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#sse_description ⇒ Types::SSEDescription
The description of the server-side encryption status on the specified DAX cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#status ⇒ String
The current status of the cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#subnet_group ⇒ String
The subnet group where the DAX cluster is running.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |
#total_nodes ⇒ Integer
The total number of nodes in the cluster.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aws-sdk-dax/types.rb', line 98 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) include Aws::Structure end |