Cluster (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.docdbelastic.model.Cluster

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Cluster
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Returns information about a specific Elastic DocumentDB cluster.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Cluster()

Constructors
Constructor and Description
`Cluster()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cluster`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdminUserName()` The name of the Elastic DocumentDB cluster administrator.
`String`	`getAuthType()` The authentication type for the Elastic DocumentDB cluster.
`String`	`getClusterArn()` The arn of the Elastic DocumentDB cluster.
`String`	`getClusterEndpoint()` The URL used to connect to the Elastic DocumentDB cluster.
`String`	`getClusterName()` The name of the Elastic DocumentDB cluster.
`String`	`getCreateTime()` The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
`String`	`getKmsKeyId()` The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
`String`	`getPreferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`Integer`	`getShardCapacity()` The capacity of each shard in the Elastic DocumentDB cluster.
`Integer`	`getShardCount()` The number of shards in the Elastic DocumentDB cluster.
`String`	`getStatus()` The status of the Elastic DocumentDB cluster.
`List<String>`	`getSubnetIds()` The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
`List<String>`	`getVpcSecurityGroupIds()` A list of EC2 VPC security groups associated with this cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdminUserName(String adminUserName)` The name of the Elastic DocumentDB cluster administrator.
`void`	`setAuthType(String authType)` The authentication type for the Elastic DocumentDB cluster.
`void`	`setClusterArn(String clusterArn)` The arn of the Elastic DocumentDB cluster.
`void`	`setClusterEndpoint(String clusterEndpoint)` The URL used to connect to the Elastic DocumentDB cluster.
`void`	`setClusterName(String clusterName)` The name of the Elastic DocumentDB cluster.
`void`	`setCreateTime(String createTime)` The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
`void`	`setPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`void`	`setShardCapacity(Integer shardCapacity)` The capacity of each shard in the Elastic DocumentDB cluster.
`void`	`setShardCount(Integer shardCount)` The number of shards in the Elastic DocumentDB cluster.
`void`	`setStatus(String status)` The status of the Elastic DocumentDB cluster.
`void`	`setSubnetIds(Collection<String> subnetIds)` The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
`void`	`setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups associated with this cluster.
`String`	`toString()` Returns a string representation of this object.
`Cluster`	`withAdminUserName(String adminUserName)` The name of the Elastic DocumentDB cluster administrator.
`Cluster`	`withAuthType(Auth authType)` The authentication type for the Elastic DocumentDB cluster.
`Cluster`	`withAuthType(String authType)` The authentication type for the Elastic DocumentDB cluster.
`Cluster`	`withClusterArn(String clusterArn)` The arn of the Elastic DocumentDB cluster.
`Cluster`	`withClusterEndpoint(String clusterEndpoint)` The URL used to connect to the Elastic DocumentDB cluster.
`Cluster`	`withClusterName(String clusterName)` The name of the Elastic DocumentDB cluster.
`Cluster`	`withCreateTime(String createTime)` The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
`Cluster`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
`Cluster`	`withPreferredMaintenanceWindow(String preferredMaintenanceWindow)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`Cluster`	`withShardCapacity(Integer shardCapacity)` The capacity of each shard in the Elastic DocumentDB cluster.
`Cluster`	`withShardCount(Integer shardCount)` The number of shards in the Elastic DocumentDB cluster.
`Cluster`	`withStatus(Status status)` The status of the Elastic DocumentDB cluster.
`Cluster`	`withStatus(String status)` The status of the Elastic DocumentDB cluster.
`Cluster`	`withSubnetIds(Collection<String> subnetIds)` The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
`Cluster`	`withSubnetIds(String... subnetIds)` The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
`Cluster`	`withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups associated with this cluster.
`Cluster`	`withVpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of EC2 VPC security groups associated with this cluster.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Cluster
```
public Cluster()
```
- Method Detail
  - setAdminUserName
```
public void setAdminUserName(String adminUserName)
```
    The name of the Elastic DocumentDB cluster administrator.
    
    Parameters:
    
    adminUserName - The name of the Elastic DocumentDB cluster administrator.
  - getAdminUserName
```
public String getAdminUserName()
```
    The name of the Elastic DocumentDB cluster administrator.
    
    Returns:
    
    The name of the Elastic DocumentDB cluster administrator.
  - withAdminUserName
```
public Cluster withAdminUserName(String adminUserName)
```
    The name of the Elastic DocumentDB cluster administrator.
    
    Parameters:
    
    adminUserName - The name of the Elastic DocumentDB cluster administrator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthType
```
public void setAuthType(String authType)
```
    The authentication type for the Elastic DocumentDB cluster.
    
    Parameters:
    
    authType - The authentication type for the Elastic DocumentDB cluster.
    
    See Also:
    
    Auth
  - getAuthType
```
public String getAuthType()
```
    The authentication type for the Elastic DocumentDB cluster.
    
    Returns:
    
    The authentication type for the Elastic DocumentDB cluster.
    
    See Also:
    
    Auth
  - withAuthType
```
public Cluster withAuthType(String authType)
```
    The authentication type for the Elastic DocumentDB cluster.
    
    Parameters:
    
    authType - The authentication type for the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Auth
  - withAuthType
```
public Cluster withAuthType(Auth authType)
```
    The authentication type for the Elastic DocumentDB cluster.
    
    Parameters:
    
    authType - The authentication type for the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Auth
  - setClusterArn
```
public void setClusterArn(String clusterArn)
```
    The arn of the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterArn - The arn of the Elastic DocumentDB cluster.
  - getClusterArn
```
public String getClusterArn()
```
    The arn of the Elastic DocumentDB cluster.
    
    Returns:
    
    The arn of the Elastic DocumentDB cluster.
  - withClusterArn
```
public Cluster withClusterArn(String clusterArn)
```
    The arn of the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterArn - The arn of the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterEndpoint
```
public void setClusterEndpoint(String clusterEndpoint)
```
    The URL used to connect to the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterEndpoint - The URL used to connect to the Elastic DocumentDB cluster.
  - getClusterEndpoint
```
public String getClusterEndpoint()
```
    The URL used to connect to the Elastic DocumentDB cluster.
    
    Returns:
    
    The URL used to connect to the Elastic DocumentDB cluster.
  - withClusterEndpoint
```
public Cluster withClusterEndpoint(String clusterEndpoint)
```
    The URL used to connect to the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterEndpoint - The URL used to connect to the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterName
```
public void setClusterName(String clusterName)
```
    The name of the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterName - The name of the Elastic DocumentDB cluster.
  - getClusterName
```
public String getClusterName()
```
    The name of the Elastic DocumentDB cluster.
    
    Returns:
    
    The name of the Elastic DocumentDB cluster.
  - withClusterName
```
public Cluster withClusterName(String clusterName)
```
    The name of the Elastic DocumentDB cluster.
    
    Parameters:
    
    clusterName - The name of the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateTime
```
public void setCreateTime(String createTime)
```
    The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    createTime - The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
  - getCreateTime
```
public String getCreateTime()
```
    The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
  - withCreateTime
```
public Cluster withCreateTime(String createTime)
```
    The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    
    Parameters:
    
    createTime - The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    
    Returns:
    
    The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
  - withKmsKeyId
```
public Cluster withKmsKeyId(String kmsKeyId)
```
    The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredMaintenanceWindow
```
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Parameters:
    
    preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
  - getPreferredMaintenanceWindow
```
public String getPreferredMaintenanceWindow()
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Returns:
    
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
  - withPreferredMaintenanceWindow
```
public Cluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Parameters:
    
    preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setShardCapacity
```
public void setShardCapacity(Integer shardCapacity)
```
    The capacity of each shard in the Elastic DocumentDB cluster.
    
    Parameters:
    
    shardCapacity - The capacity of each shard in the Elastic DocumentDB cluster.
  - getShardCapacity
```
public Integer getShardCapacity()
```
    The capacity of each shard in the Elastic DocumentDB cluster.
    
    Returns:
    
    The capacity of each shard in the Elastic DocumentDB cluster.
  - withShardCapacity
```
public Cluster withShardCapacity(Integer shardCapacity)
```
    The capacity of each shard in the Elastic DocumentDB cluster.
    
    Parameters:
    
    shardCapacity - The capacity of each shard in the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setShardCount
```
public void setShardCount(Integer shardCount)
```
    The number of shards in the Elastic DocumentDB cluster.
    
    Parameters:
    
    shardCount - The number of shards in the Elastic DocumentDB cluster.
  - getShardCount
```
public Integer getShardCount()
```
    The number of shards in the Elastic DocumentDB cluster.
    
    Returns:
    
    The number of shards in the Elastic DocumentDB cluster.
  - withShardCount
```
public Cluster withShardCount(Integer shardCount)
```
    The number of shards in the Elastic DocumentDB cluster.
    
    Parameters:
    
    shardCount - The number of shards in the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the Elastic DocumentDB cluster.
    
    Parameters:
    
    status - The status of the Elastic DocumentDB cluster.
    
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    The status of the Elastic DocumentDB cluster.
    
    Returns:
    
    The status of the Elastic DocumentDB cluster.
    
    See Also:
    
    Status
  - withStatus
```
public Cluster withStatus(String status)
```
    The status of the Elastic DocumentDB cluster.
    
    Parameters:
    
    status - The status of the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - withStatus
```
public Cluster withStatus(Status status)
```
    The status of the Elastic DocumentDB cluster.
    
    Parameters:
    
    status - The status of the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    
    Returns:
    
    The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
  - withSubnetIds
```
public Cluster withSubnetIds(String... subnetIds)
```
    The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public Cluster withSubnetIds(Collection<String> subnetIds)
```
    The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSecurityGroupIds
```
public List<String> getVpcSecurityGroupIds()
```
    A list of EC2 VPC security groups associated with this cluster.
    
    Returns:
    
    A list of EC2 VPC security groups associated with this cluster.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups associated with this cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups associated with this cluster.
  - withVpcSecurityGroupIds
```
public Cluster withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups associated with this cluster.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups associated with this cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcSecurityGroupIds
```
public Cluster withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups associated with this cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups associated with this cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Cluster clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.653

Class Cluster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cluster

Method Detail

setAdminUserName

getAdminUserName

withAdminUserName

setAuthType

getAuthType

withAuthType

withAuthType

setClusterArn

getClusterArn

withClusterArn

setClusterEndpoint

getClusterEndpoint

withClusterEndpoint

setClusterName

getClusterName

withClusterName

setCreateTime

getCreateTime

withCreateTime

setKmsKeyId

getKmsKeyId

withKmsKeyId

setPreferredMaintenanceWindow

getPreferredMaintenanceWindow

withPreferredMaintenanceWindow

setShardCapacity

getShardCapacity

withShardCapacity

setShardCount

getShardCount

withShardCount

setStatus

getStatus

withStatus

withStatus

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

getVpcSecurityGroupIds

setVpcSecurityGroupIds

withVpcSecurityGroupIds

withVpcSecurityGroupIds

toString

equals

hashCode

clone

marshall