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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains all of the attributes of a specific DAX cluster.

Returned by:

See Also:

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) —

    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.

Returns:

  • (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. 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:

  • (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.

Returns:

  • (String) —

    The name of the DAX cluster.

#description ⇒ String

The description of the cluster.

Returns:

  • (String) —

    The description of the cluster.

#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) —

    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.

Returns:

  • (Array<String>) —

    A list of nodes to be removed from the cluster.

#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) —

    The node type for the nodes in the cluster.

#nodes ⇒ Array<Types::Node>

A list of nodes that are currently in the cluster.

Returns:

  • (Array<Types::Node>) —

    A list of nodes that are currently in the cluster.

#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:

#parameter_group ⇒ Types::ParameterGroupStatus

The parameter group being used by nodes in the cluster.

Returns:

#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) —

    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.

Returns:

#sse_description ⇒ Types::SSEDescription

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

Returns:

  • (Types::SSEDescription) —

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

#status ⇒ String

The current status of the cluster.

Returns:

  • (String) —

    The current status of the cluster.

#subnet_group ⇒ String

The subnet group where the DAX cluster is running.

Returns:

  • (String) —

    The subnet group where the DAX cluster is running.

#total_nodes ⇒ Integer

The total number of nodes in the cluster.

Returns:

  • (Integer) —

    The total number of nodes in the cluster.