java.lang.Object
- software.amazon.awssdk.services.docdbelastic.model.ClusterSnapshot

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ClusterSnapshot.Builder,ClusterSnapshot>

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

Returns information about a specific elastic cluster snapshot.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ClusterSnapshot.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`adminUserName()`	The name of the elastic cluster administrator.
`static ClusterSnapshot.Builder`	`builder()`
`String`	`clusterArn()`	The ARN identifier of the elastic cluster.
`String`	`clusterCreationTime()`	The time when the elastic 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 is the Amazon Resource Name (ARN) for the KMS encryption key.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ClusterSnapshot.Builder>`	`serializableBuilderClass()`
`String`	`snapshotArn()`	The ARN identifier of the elastic cluster snapshot.
`String`	`snapshotCreationTime()`	The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
`String`	`snapshotName()`	The name of the elastic cluster snapshot.
`SnapshotType`	`snapshotType()`	The type of cluster snapshots to be returned.
`String`	`snapshotTypeAsString()`	The type of cluster snapshots to be returned.
`Status`	`status()`	The status of the elastic cluster snapshot.
`String`	`statusAsString()`	The status of the elastic cluster snapshot.
`List<String>`	`subnetIds()`	The Amazon EC2 subnet IDs for the elastic cluster.
`ClusterSnapshot.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`vpcSecurityGroupIds()`	A list of EC2 VPC security groups to associate with the elastic 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 cluster administrator.
    
    Returns:
    
    The name of the elastic cluster administrator.
  - clusterArn
```
public final String clusterArn()
```
    The ARN identifier of the elastic cluster.
    
    Returns:
    
    The ARN identifier of the elastic cluster.
  - clusterCreationTime
```
public final String clusterCreationTime()
```
    The time when the elastic cluster was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the elastic cluster was created in Universal Coordinated Time (UTC).
  - kmsKeyId
```
public final String kmsKeyId()
```
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Returns:
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
  - snapshotArn
```
public final String snapshotArn()
```
    The ARN identifier of the elastic cluster snapshot.
    
    Returns:
    
    The ARN identifier of the elastic cluster snapshot.
  - snapshotCreationTime
```
public final String snapshotCreationTime()
```
    The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
    
    Returns:
    
    The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
  - snapshotName
```
public final String snapshotName()
```
    The name of the elastic cluster snapshot.
    
    Returns:
    
    The name of the elastic cluster snapshot.
  - snapshotType
```
public final SnapshotType snapshotType()
```
    The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    
    If the service returns an enum value that is not available in the current SDK version, snapshotType will return SnapshotType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snapshotTypeAsString().
    Returns:
    
    The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    
    See Also:
    
    SnapshotType
  - snapshotTypeAsString
```
public final String snapshotTypeAsString()
```
    The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    
    If the service returns an enum value that is not available in the current SDK version, snapshotType will return SnapshotType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snapshotTypeAsString().
    Returns:
    
    The type of cluster snapshots to be returned. You can specify one of the following values:
    
    automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    
    manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
    
    See Also:
    
    SnapshotType
  - status
```
public final Status status()
```
    The status of the elastic cluster snapshot.
    
    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 cluster snapshot.
    
    See Also:
    
    Status
  - statusAsString
```
public final String statusAsString()
```
    The status of the elastic cluster snapshot.
    
    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 cluster snapshot.
    
    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 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 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 to associate with the elastic 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 to associate with the elastic cluster.
  - toBuilder
```
public ClusterSnapshot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ClusterSnapshot.Builder,ClusterSnapshot>
  - builder
```
public static ClusterSnapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ClusterSnapshot.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

Class ClusterSnapshot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

adminUserName

clusterArn

clusterCreationTime

kmsKeyId

snapshotArn

snapshotCreationTime

snapshotName

snapshotType

snapshotTypeAsString

status

statusAsString

hasSubnetIds

subnetIds

hasVpcSecurityGroupIds

vpcSecurityGroupIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields