@Generated(value="software.amazon.awssdk:codegen") public class Cluster extends Object implements StructuredPojo, ToCopyableBuilder<Cluster.Builder,Cluster>
Contains all of the attributes of a specific DAX cluster.
Modifier and Type | Class and Description |
---|---|
static interface |
Cluster.Builder |
Modifier and Type | Method and Description |
---|---|
Integer |
activeNodes()
The number of nodes in the cluster that are active (i.e., capable of serving requests).
|
static Cluster.Builder |
builder() |
String |
clusterArn()
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
|
Endpoint |
clusterDiscoveryEndpoint()
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number.
|
String |
clusterName()
The name of the DAX cluster.
|
String |
description()
The description of the cluster.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
iamRoleArn()
A valid Amazon Resource Name (ARN) that identifies an IAM role.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
List<String> |
nodeIdsToRemove()
A list of nodes to be removed from the cluster.
|
List<Node> |
nodes()
A list of nodes that are currently in the cluster.
|
String |
nodeType()
The node type for the nodes in the cluster.
|
NotificationConfiguration |
notificationConfiguration()
Describes a notification topic and its status.
|
ParameterGroupStatus |
parameterGroup()
The parameter group being used by nodes in the cluster.
|
String |
preferredMaintenanceWindow()
A range of time when maintenance of DAX cluster software will be performed.
|
List<SecurityGroupMembership> |
securityGroups()
A list of security groups, and the status of each, for the nodes in the cluster.
|
static Class<? extends Cluster.Builder> |
serializableBuilderClass() |
String |
status()
The current status of the cluster.
|
String |
subnetGroup()
The subnet group where the DAX cluster is running.
|
Cluster.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Integer |
totalNodes()
The total number of nodes in the cluster.
|
copy
public String clusterName()
The name of the DAX cluster.
public String description()
The description of the cluster.
public String clusterArn()
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
public Integer totalNodes()
The total number of nodes in the cluster.
public Integer activeNodes()
The number of nodes in the cluster that are active (i.e., capable of serving requests).
public String nodeType()
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
public String status()
The current status of the cluster.
public Endpoint clusterDiscoveryEndpoint()
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.
public List<String> nodeIdsToRemove()
A list of nodes to be removed from the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Node> nodes()
A list of nodes that are currently in the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String preferredMaintenanceWindow()
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.
sun:01:00-sun:09:00
. Cluster maintenance normally takes less than 30 minutes, and is
performed automatically within the maintenance window.public NotificationConfiguration notificationConfiguration()
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
public String subnetGroup()
The subnet group where the DAX cluster is running.
public List<SecurityGroupMembership> securityGroups()
A list of security groups, and the status of each, for the nodes in the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String iamRoleArn()
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.
public ParameterGroupStatus parameterGroup()
The parameter group being used by nodes in the cluster.
public Cluster.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Cluster.Builder,Cluster>
public static Cluster.Builder builder()
public static Class<? extends Cluster.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.