software.amazon.awssdk.services.docdbelastic.model

Class Cluster

java.lang.Object

software.amazon.awssdk.services.docdbelastic.model.Cluster

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

@Generated(value="software.amazon.awssdk:codegen")
public final class Cluster
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Cluster.Builder,Cluster>

Returns information about a specific Elastic DocumentDB cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Cluster.Builder

Method Summary

Modifier and Type	Method and Description
String	adminUserName() The name of the Elastic DocumentDB cluster administrator.
Auth	authType() The authentication type for the Elastic DocumentDB cluster.
String	authTypeAsString() The authentication type for the Elastic DocumentDB cluster.
static Cluster.Builder	builder()
String	clusterArn() The arn of the Elastic DocumentDB cluster.
String	clusterEndpoint() The URL used to connect to the Elastic DocumentDB cluster.
String	clusterName() The name of the Elastic DocumentDB cluster.
String	createTime() The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubnetIds() For responses, this returns true if the service returned a value for the SubnetIds property.
boolean	hasVpcSecurityGroupIds() For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
String	kmsKeyId() The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
String	preferredMaintenanceWindow() The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
List<SdkField<?>>	sdkFields()
static Class<? extends Cluster.Builder>	serializableBuilderClass()
Integer	shardCapacity() The capacity of each shard in the Elastic DocumentDB cluster.
Integer	shardCount() The number of shards in the Elastic DocumentDB cluster.
Status	status() The status of the Elastic DocumentDB cluster.
String	statusAsString() The status of the Elastic DocumentDB cluster.
List<String>	subnetIds() The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
Cluster.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	vpcSecurityGroupIds() A list of EC2 VPC security groups associated with this cluster.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

adminUserName

public final String adminUserName()

The name of the Elastic DocumentDB cluster administrator.

Returns:

The name of the Elastic DocumentDB cluster administrator.

authType

public final Auth authType()

The authentication type for the Elastic DocumentDB cluster.

If the service returns an enum value that is not available in the current SDK version, authType will return Auth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

Returns:

The authentication type for the Elastic DocumentDB cluster.

See Also:

Auth

authTypeAsString

public final String authTypeAsString()

The authentication type for the Elastic DocumentDB cluster.

If the service returns an enum value that is not available in the current SDK version, authType will return Auth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

Returns:

The authentication type for the Elastic DocumentDB cluster.

See Also:

Auth

clusterArn

public final String clusterArn()

The arn of the Elastic DocumentDB cluster.

Returns:

The arn of the Elastic DocumentDB cluster.

clusterEndpoint

public final String clusterEndpoint()

The URL used to connect to the Elastic DocumentDB cluster.

Returns:

The URL used to connect to the Elastic DocumentDB cluster.

clusterName

public final String clusterName()

The name of the Elastic DocumentDB cluster.

Returns:

The name of the Elastic DocumentDB cluster.

createTime

public final String createTime()

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

kmsKeyId

public final String kmsKeyId()

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.

preferredMaintenanceWindow

public final String preferredMaintenanceWindow()

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

shardCapacity

public final Integer shardCapacity()

The capacity of each shard in the Elastic DocumentDB cluster.

Returns:

The capacity of each shard in the Elastic DocumentDB cluster.

shardCount

public final Integer shardCount()

The number of shards in the Elastic DocumentDB cluster.

Returns:

The number of shards in the Elastic DocumentDB cluster.

status

public final Status status()

The status of the Elastic DocumentDB cluster.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the Elastic DocumentDB cluster.

See Also:

Status

statusAsString

public final String statusAsString()

The status of the Elastic DocumentDB cluster.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the Elastic DocumentDB cluster.

See Also:

Status

hasSubnetIds

public final boolean hasSubnetIds()

For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

subnetIds

public final List<String> subnetIds()

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

Returns:

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

hasVpcSecurityGroupIds

public final boolean hasVpcSecurityGroupIds()

For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

vpcSecurityGroupIds

public final List<String> vpcSecurityGroupIds()

A list of EC2 VPC security groups associated with this cluster.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

Returns:

A list of EC2 VPC security groups associated with this cluster.

toBuilder

public Cluster.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>

builder

public static Cluster.Builder builder()

serializableBuilderClass

public static Class<? extends Cluster.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo