software.amazon.awssdk.services.neptune.model

Class DBClusterSnapshot

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

Method Summary

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 a 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)
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()
Boolean	iamDatabaseAuthenticationEnabled() True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
String	kmsKeyId() If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.
String	licenseModel() Provides the license model information for this DB cluster snapshot.
String	masterUsername() Not supported by Neptune.
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()
String	toString() Returns a string representation of this object.
String	vpcId() Provides the VPC ID associated with the DB 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 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.

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 EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

dbClusterSnapshotIdentifier

public final String dbClusterSnapshotIdentifier()

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

Returns:

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

dbClusterIdentifier

public final 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 final 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 final String engine()

Specifies the name of the database engine.

Returns:

Specifies the name of the database engine.

allocatedStorage

public final Integer allocatedStorage()

Specifies the allocated storage size in gibibytes (GiB).

Returns:

Specifies the allocated storage size in gibibytes (GiB).

status

public final String status()

Specifies the status of this DB cluster snapshot.

Returns:

Specifies the status of this DB cluster snapshot.

port

public final 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 final 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 final 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 final String masterUsername()

Not supported by Neptune.

Returns:

Not supported by Neptune.

engineVersion

public final 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 final 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 final String snapshotType()

Provides the type of the DB cluster snapshot.

Returns:

Provides the type of the DB 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 DB cluster snapshot is encrypted.

Returns:

Specifies whether the DB cluster snapshot is encrypted.

kmsKeyId

public final String kmsKeyId()

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.

Returns:

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.

dbClusterSnapshotArn

public final 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 final 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 final Boolean iamDatabaseAuthenticationEnabled()

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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