Class DBClusterSnapshot
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
Specifies the allocated storage size in gibibytes (GiB).Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.static DBClusterSnapshot.Builder
builder()
final Instant
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).final String
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.final String
The Amazon Resource Name (ARN) for the DB cluster snapshot.final String
Specifies the identifier for a DB cluster snapshot.final String
engine()
Specifies the name of the database engine.final String
Provides the version of the database engine for this DB cluster snapshot.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AvailabilityZones property.final int
hashCode()
final Boolean
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.final String
kmsKeyId()
IfStorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.final String
Provides the license model information for this DB cluster snapshot.final String
Not supported by Neptune.final Integer
Specifies the percentage of the estimated data that has been transferred.final Integer
port()
Specifies the port that the DB cluster was listening on at the time of the snapshot.static Class
<? extends DBClusterSnapshot.Builder> final Instant
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).final String
Provides the type of the DB cluster snapshot.final String
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.final String
status()
Specifies the status of this DB cluster snapshot.final Boolean
Specifies whether the DB cluster snapshot is encrypted.final String
The storage type associated with the DB cluster snapshot.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
vpcId()
Provides the VPC ID associated with the DB cluster snapshot.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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 sameDBClusterSnapshotIdentifier
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 theDBClusterSnapshotIdentifier
, 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 sameDBClusterSnapshotIdentifier
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 theDBClusterSnapshotIdentifier
, and the original DB cluster is deleted.
-
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
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
Specifies the name of the database engine.
- Returns:
- Specifies the name of the database engine.
-
allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
- Returns:
- Specifies the allocated storage size in gibibytes (GiB).
-
status
Specifies the status of this DB cluster snapshot.
- Returns:
- Specifies the status of this DB cluster snapshot.
-
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
Provides the VPC ID associated with the DB cluster snapshot.
- Returns:
- Provides the VPC ID associated with the DB cluster snapshot.
-
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
Not supported by Neptune.
- Returns:
- Not supported by Neptune.
-
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
Provides the license model information for this DB cluster snapshot.
- Returns:
- Provides the license model information for this DB cluster snapshot.
-
snapshotType
Provides the type of the DB cluster snapshot.
- Returns:
- Provides the type of the DB cluster snapshot.
-
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
Specifies whether the DB cluster snapshot is encrypted.
- Returns:
- Specifies whether the DB cluster snapshot is encrypted.
-
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
The Amazon Resource Name (ARN) for the DB cluster snapshot.
- Returns:
- The Amazon Resource Name (ARN) for the DB cluster snapshot.
-
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
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.
-
storageType
The storage type associated with the DB cluster snapshot.
- Returns:
- The storage type associated with the DB cluster snapshot.
-
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 interfaceToCopyableBuilder<DBClusterSnapshot.Builder,
DBClusterSnapshot> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-