java.lang.Object
- software.amazon.awssdk.services.docdb.model.DBClusterSnapshot

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

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

Detailed information about a cluster snapshot.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DBClusterSnapshot.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`availabilityZones()`	Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
`static DBClusterSnapshot.Builder`	`builder()`
`Instant`	`clusterCreateTime()`	Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
`String`	`dbClusterIdentifier()`	Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
`String`	`dbClusterSnapshotArn()`	The Amazon Resource Name (ARN) for the cluster snapshot.
`String`	`dbClusterSnapshotIdentifier()`	Specifies the identifier for the cluster snapshot.
`String`	`engine()`	Specifies the name of the database engine.
`String`	`engineVersion()`	Provides the version of the database engine for this cluster snapshot.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()`	For responses, this returns true if the service returned a value for the AvailabilityZones property.
`int`	`hashCode()`
`String`	`kmsKeyId()`	If `StorageEncrypted` is `true`, the KMS key identifier for the encrypted cluster snapshot.
`String`	`masterUsername()`	Provides the master user name for the cluster snapshot.
`Integer`	`percentProgress()`	Specifies the percentage of the estimated data that has been transferred.
`Integer`	`port()`	Specifies the port that the cluster was listening on at the time of the snapshot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DBClusterSnapshot.Builder>`	`serializableBuilderClass()`
`Instant`	`snapshotCreateTime()`	Provides the time when the snapshot was taken, in UTC.
`String`	`snapshotType()`	Provides the type of the cluster snapshot.
`String`	`sourceDBClusterSnapshotArn()`	If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
`String`	`status()`	Specifies the status of this cluster snapshot.
`Boolean`	`storageEncrypted()`	Specifies whether the cluster snapshot is encrypted.
`String`	`storageType()`	Storage type associated with your cluster snapshot
`DBClusterSnapshot.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`vpcId()`	Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

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
  - hasAvailabilityZones
```
public final boolean hasAvailabilityZones()
```
    For responses, this returns true if the service returned a value for the AvailabilityZones 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.
  - availabilityZones
```
public final List<String> availabilityZones()
```
    Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
    
    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 hasAvailabilityZones() method.
    
    Returns:
    
    Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
  - dbClusterSnapshotIdentifier
```
public final String dbClusterSnapshotIdentifier()
```
    Specifies the identifier for the cluster snapshot.
    
    Returns:
    
    Specifies the identifier for the cluster snapshot.
  - dbClusterIdentifier
```
public final String dbClusterIdentifier()
```
    Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
    
    Returns:
    
    Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
  - snapshotCreateTime
```
public final Instant snapshotCreateTime()
```
    Provides the time when the snapshot was taken, in UTC.
    
    Returns:
    
    Provides the time when the snapshot was taken, in UTC.
  - engine
```
public final String engine()
```
    Specifies the name of the database engine.
    
    Returns:
    
    Specifies the name of the database engine.
  - status
```
public final String status()
```
    Specifies the status of this cluster snapshot.
    
    Returns:
    
    Specifies the status of this cluster snapshot.
  - port
```
public final Integer port()
```
    Specifies the port that the cluster was listening on at the time of the snapshot.
    
    Returns:
    
    Specifies the port that the cluster was listening on at the time of the snapshot.
  - vpcId
```
public final String vpcId()
```
    Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
    
    Returns:
    
    Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
  - clusterCreateTime
```
public final Instant clusterCreateTime()
```
    Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
  - masterUsername
```
public final String masterUsername()
```
    Provides the master user name for the cluster snapshot.
    
    Returns:
    
    Provides the master user name for the cluster snapshot.
  - engineVersion
```
public final String engineVersion()
```
    Provides the version of the database engine for this cluster snapshot.
    
    Returns:
    
    Provides the version of the database engine for this cluster snapshot.
  - snapshotType
```
public final String snapshotType()
```
    Provides the type of the cluster snapshot.
    
    Returns:
    
    Provides the type of the cluster snapshot.
  - percentProgress
```
public final Integer percentProgress()
```
    Specifies the percentage of the estimated data that has been transferred.
    
    Returns:
    
    Specifies the percentage of the estimated data that has been transferred.
  - storageEncrypted
```
public final Boolean storageEncrypted()
```
    Specifies whether the cluster snapshot is encrypted.
    
    Returns:
    
    Specifies whether the cluster snapshot is encrypted.
  - kmsKeyId
```
public final String kmsKeyId()
```
    If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.
    
    Returns:
    
    If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.
  - dbClusterSnapshotArn
```
public final String dbClusterSnapshotArn()
```
    The Amazon Resource Name (ARN) for the cluster snapshot.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the cluster snapshot.
  - sourceDBClusterSnapshotArn
```
public final String sourceDBClusterSnapshotArn()
```
    If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
    
    Returns:
    
    If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
  - storageType
```
public final String storageType()
```
    Storage type associated with your cluster snapshot
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
    
    Returns:
    
    Storage type associated with your cluster snapshot
    
    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
    
    Valid values for storage type - standard | iopt1
    
    Default value is standard
  - toBuilder
```
public DBClusterSnapshot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>
  - builder
```
public static DBClusterSnapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBClusterSnapshot.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 DBClusterSnapshot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAvailabilityZones

availabilityZones

dbClusterSnapshotIdentifier

dbClusterIdentifier

snapshotCreateTime

engine

status

port

vpcId

clusterCreateTime

masterUsername

engineVersion

snapshotType

percentProgress

storageEncrypted

kmsKeyId

dbClusterSnapshotArn

sourceDBClusterSnapshotArn

storageType

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields