Class DBClusterSnapshot
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DBClusterSnapshot.Builder,
DBClusterSnapshot>
Contains the details for an Amazon RDS 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
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.static DBClusterSnapshot.Builder
builder()
final Instant
The time when the DB cluster was created, in Universal Coordinated Time (UTC).final String
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.final String
The resource ID 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
The identifier for the DB cluster snapshot.final String
Reserved for future use.final String
engine()
The name of the database engine for this DB cluster snapshot.final String
The engine mode of the database engine for this DB cluster snapshot.final String
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
For responses, this returns true if the service returned a value for the TagList property.final Boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.final String
kmsKeyId()
IfStorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.final String
The license model information for this DB cluster snapshot.final String
The master username for this DB cluster snapshot.final Integer
The percentage of the estimated data that has been transferred.final Integer
port()
The port that the DB cluster was listening on at the time of the snapshot.static Class
<? extends DBClusterSnapshot.Builder> final Instant
The time when the snapshot was taken, in Universal Coordinated Time (UTC).final String
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()
The status of this DB cluster snapshot.final Boolean
Indicates whether the DB cluster snapshot is encrypted.final Integer
The storage throughput for the DB cluster snapshot.final String
The storage type associated with the DB cluster snapshot.tagList()
Returns the value of the TagList property for this object.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()
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
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
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:
- The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
-
dbClusterSnapshotIdentifier
The identifier for the DB cluster snapshot.
- Returns:
- The identifier for the DB cluster snapshot.
-
dbClusterIdentifier
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
- Returns:
- The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
-
snapshotCreateTime
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
- Returns:
- The time when the snapshot was taken, in Universal Coordinated Time (UTC).
-
engine
The name of the database engine for this DB cluster snapshot.
- Returns:
- The name of the database engine for this DB cluster snapshot.
-
engineMode
The engine mode of the database engine for this DB cluster snapshot.
- Returns:
- The engine mode of the database engine for this DB cluster snapshot.
-
allocatedStorage
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
- Returns:
- The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
-
status
The status of this DB cluster snapshot. Valid statuses are the following:
-
available
-
copying
-
creating
- Returns:
- The status of this DB cluster snapshot. Valid statuses are the following:
-
available
-
copying
-
creating
-
-
-
port
The port that the DB cluster was listening on at the time of the snapshot.
- Returns:
- The port that the DB cluster was listening on at the time of the snapshot.
-
vpcId
The VPC ID associated with the DB cluster snapshot.
- Returns:
- The VPC ID associated with the DB cluster snapshot.
-
clusterCreateTime
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
- Returns:
- The time when the DB cluster was created, in Universal Coordinated Time (UTC).
-
masterUsername
The master username for this DB cluster snapshot.
- Returns:
- The master username for this DB cluster snapshot.
-
engineVersion
The version of the database engine for this DB cluster snapshot.
- Returns:
- The version of the database engine for this DB cluster snapshot.
-
licenseModel
The license model information for this DB cluster snapshot.
- Returns:
- The license model information for this DB cluster snapshot.
-
snapshotType
The type of the DB cluster snapshot.
- Returns:
- The type of the DB cluster snapshot.
-
percentProgress
The percentage of the estimated data that has been transferred.
- Returns:
- The percentage of the estimated data that has been transferred.
-
storageEncrypted
Indicates whether the DB cluster snapshot is encrypted.
- Returns:
- Indicates whether the DB cluster snapshot is encrypted.
-
kmsKeyId
If
StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
- Returns:
- If
StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
-
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
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- Returns:
- Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
-
hasTagList
public final boolean hasTagList()For responses, this returns true if the service returned a value for the TagList 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. -
tagList
Returns the value of the TagList property for this object.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
hasTagList()
method.- Returns:
- The value of the TagList property for this object.
-
dbSystemId
Reserved for future use.
- Returns:
- Reserved for future use.
-
storageType
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
- Returns:
- The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
-
dbClusterResourceId
The resource ID of the DB cluster that this DB cluster snapshot was created from.
- Returns:
- The resource ID of the DB cluster that this DB cluster snapshot was created from.
-
storageThroughput
The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS
that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
-
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
-