DBClusterSnapshot (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DBClusterSnapshot
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>
```
Contains the details for an Amazon Neptune DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DBClusterSnapshot.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DBClusterSnapshot.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`allocatedStorage()` Specifies the allocated storage size in gibibytes (GiB).
`List<String>`	`availabilityZones()` Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
`static DBClusterSnapshot.Builder`	`builder()`
`Instant`	`clusterCreateTime()` Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
`String`	`dbClusterIdentifier()` Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
`String`	`dbClusterSnapshotArn()` The Amazon Resource Name (ARN) for the DB cluster snapshot.
`String`	`dbClusterSnapshotIdentifier()` Specifies the identifier for the DB cluster snapshot.
`String`	`engine()` Specifies the name of the database engine.
`String`	`engineVersion()` Provides the version of the database engine for this DB cluster snapshot.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`iamDatabaseAuthenticationEnabled()` True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
`String`	`kmsKeyId()` If `StorageEncrypted` is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
`String`	`licenseModel()` Provides the license model information for this DB cluster snapshot.
`String`	`masterUsername()` Provides the master username for the DB cluster snapshot.
`Integer`	`percentProgress()` Specifies the percentage of the estimated data that has been transferred.
`Integer`	`port()` Specifies the port that the DB 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 Universal Coordinated Time (UTC).
`String`	`snapshotType()` Provides the type of the DB cluster snapshot.
`String`	`sourceDBClusterSnapshotArn()` If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
`String`	`status()` Specifies the status of this DB cluster snapshot.
`Boolean`	`storageEncrypted()` Specifies whether the DB cluster snapshot is encrypted.
`DBClusterSnapshot.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`vpcId()` Provides the VPC ID associated with the DB cluster snapshot.

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

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

- Method Detail
  - availabilityZones
```
public List<String> availabilityZones()
```
    Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
  - dbClusterSnapshotIdentifier
```
public String dbClusterSnapshotIdentifier()
```
    Specifies the identifier for the DB cluster snapshot.
    
    Returns:
    
    Specifies the identifier for the DB cluster snapshot.
  - dbClusterIdentifier
```
public String dbClusterIdentifier()
```
    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
    
    Returns:
    
    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
  - snapshotCreateTime
```
public Instant snapshotCreateTime()
```
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - engine
```
public String engine()
```
    Specifies the name of the database engine.
    
    Returns:
    
    Specifies the name of the database engine.
  - allocatedStorage
```
public Integer allocatedStorage()
```
    Specifies the allocated storage size in gibibytes (GiB).
    
    Returns:
    
    Specifies the allocated storage size in gibibytes (GiB).
  - status
```
public String status()
```
    Specifies the status of this DB cluster snapshot.
    
    Returns:
    
    Specifies the status of this DB cluster snapshot.
  - port
```
public Integer port()
```
    Specifies the port that the DB cluster was listening on at the time of the snapshot.
    
    Returns:
    
    Specifies the port that the DB cluster was listening on at the time of the snapshot.
  - vpcId
```
public String vpcId()
```
    Provides the VPC ID associated with the DB cluster snapshot.
    
    Returns:
    
    Provides the VPC ID associated with the DB cluster snapshot.
  - clusterCreateTime
```
public Instant clusterCreateTime()
```
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - masterUsername
```
public String masterUsername()
```
    Provides the master username for the DB cluster snapshot.
    
    Returns:
    
    Provides the master username for the DB cluster snapshot.
  - engineVersion
```
public String engineVersion()
```
    Provides the version of the database engine for this DB cluster snapshot.
    
    Returns:
    
    Provides the version of the database engine for this DB cluster snapshot.
  - licenseModel
```
public String licenseModel()
```
    Provides the license model information for this DB cluster snapshot.
    
    Returns:
    
    Provides the license model information for this DB cluster snapshot.
  - snapshotType
```
public String snapshotType()
```
    Provides the type of the DB cluster snapshot.
    
    Returns:
    
    Provides the type of the DB cluster snapshot.
  - percentProgress
```
public 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 Boolean storageEncrypted()
```
    Specifies whether the DB cluster snapshot is encrypted.
    
    Returns:
    
    Specifies whether the DB cluster snapshot is encrypted.
  - kmsKeyId
```
public String kmsKeyId()
```
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    
    Returns:
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
  - dbClusterSnapshotArn
```
public String dbClusterSnapshotArn()
```
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
  - sourceDBClusterSnapshotArn
```
public String sourceDBClusterSnapshotArn()
```
    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
    
    Returns:
    
    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
  - iamDatabaseAuthenticationEnabled
```
public Boolean iamDatabaseAuthenticationEnabled()
```
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    Returns:
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - toBuilder
```
public DBClusterSnapshot.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DBClusterSnapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBClusterSnapshot.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

availabilityZones

dbClusterSnapshotIdentifier

dbClusterIdentifier

snapshotCreateTime

engine

allocatedStorage

status

port

vpcId

clusterCreateTime

masterUsername

engineVersion

licenseModel

snapshotType

percentProgress

storageEncrypted

kmsKeyId

dbClusterSnapshotArn

sourceDBClusterSnapshotArn

iamDatabaseAuthenticationEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields