Class AwsRdsDbSnapshotDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsRdsDbSnapshotDetails.Builder,
AwsRdsDbSnapshotDetails>
Provides details about an Amazon RDS DB cluster snapshot.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The amount of storage (in gigabytes) to be initially allocated for the database instance.final String
Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.builder()
final String
A name for the DB instance.final String
The identifier for the source DB instance.final String
The name or ARN of the DB snapshot that is used to restore the DB instance.final Boolean
Whether the DB snapshot is encrypted.final String
engine()
The name of the database engine to use for this DB instance.final String
The version of the database engine.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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ProcessorFeatures property.final Boolean
Whether mapping of IAM accounts to database accounts is enabled.final String
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.final Integer
iops()
The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.final String
kmsKeyId()
IfEncrypted
istrue
, the KMS key identifier for the encrypted DB snapshot.final String
License model information for the restored DB instance.final String
The master user name for the DB snapshot.final String
The option group name for the DB snapshot.final Integer
The percentage of the estimated data that has been transferred.final Integer
port()
The port that the database engine was listening on at the time of the snapshot.final List
<AwsRdsDbProcessorFeature> The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.static Class
<? extends AwsRdsDbSnapshotDetails.Builder> final String
When the snapshot was taken in Coordinated Universal Time (UTC).final String
The type of the DB snapshot.final String
The DB snapshot ARN that the DB snapshot was copied from.final String
The Amazon Web Services Region that the DB snapshot was created in or copied from.final String
status()
The status of this DB snapshot.final String
The storage type associated with the DB snapshot.final String
The ARN from the key store with which to associate the instance for TDE encryption.final String
timezone()
The time zone of the DB 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()
The VPC ID associated with the DB snapshot.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
dbSnapshotIdentifier
The name or ARN of the DB snapshot that is used to restore the DB instance.
- Returns:
- The name or ARN of the DB snapshot that is used to restore the DB instance.
-
dbInstanceIdentifier
A name for the DB instance.
- Returns:
- A name for the DB instance.
-
snapshotCreateTime
When the snapshot was taken in Coordinated Universal Time (UTC).
- Returns:
- When the snapshot was taken in Coordinated Universal Time (UTC).
-
engine
The name of the database engine to use for this DB instance. Valid values are as follows:
-
aurora
-
aurora-mysql
-
aurora-postgresql
-
c
-
mariadb
-
mysql
-
oracle-ee
-
oracle-se
-
oracle-se1
-
oracle-se2
-
sqlserver-ee
-
sqlserver-ex
-
sqlserver-se
-
sqlserver-web
- Returns:
- The name of the database engine to use for this DB instance. Valid values are as follows:
-
aurora
-
aurora-mysql
-
aurora-postgresql
-
c
-
mariadb
-
mysql
-
oracle-ee
-
oracle-se
-
oracle-se1
-
oracle-se2
-
sqlserver-ee
-
sqlserver-ex
-
sqlserver-se
-
sqlserver-web
-
-
-
allocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the database instance.
- Returns:
- The amount of storage (in gigabytes) to be initially allocated for the database instance.
-
status
The status of this DB snapshot.
- Returns:
- The status of this DB snapshot.
-
port
The port that the database engine was listening on at the time of the snapshot.
- Returns:
- The port that the database engine was listening on at the time of the snapshot.
-
availabilityZone
Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.
- Returns:
- Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.
-
vpcId
The VPC ID associated with the DB snapshot.
- Returns:
- The VPC ID associated with the DB snapshot.
-
instanceCreateTime
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
- Returns:
- Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
-
masterUsername
The master user name for the DB snapshot.
- Returns:
- The master user name for the DB snapshot.
-
engineVersion
The version of the database engine.
- Returns:
- The version of the database engine.
-
licenseModel
License model information for the restored DB instance.
- Returns:
- License model information for the restored DB instance.
-
snapshotType
The type of the DB snapshot.
- Returns:
- The type of the DB snapshot.
-
iops
The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
- Returns:
- The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
-
optionGroupName
The option group name for the DB snapshot.
- Returns:
- The option group name for the DB snapshot.
-
percentProgress
The percentage of the estimated data that has been transferred.
- Returns:
- The percentage of the estimated data that has been transferred.
-
sourceRegion
The Amazon Web Services Region that the DB snapshot was created in or copied from.
- Returns:
- The Amazon Web Services Region that the DB snapshot was created in or copied from.
-
sourceDbSnapshotIdentifier
The DB snapshot ARN that the DB snapshot was copied from.
- Returns:
- The DB snapshot ARN that the DB snapshot was copied from.
-
storageType
The storage type associated with the DB snapshot. Valid values are as follows:
-
gp2
-
io1
-
standard
- Returns:
- The storage type associated with the DB snapshot. Valid values are as follows:
-
gp2
-
io1
-
standard
-
-
-
tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
- Returns:
- The ARN from the key store with which to associate the instance for TDE encryption.
-
encrypted
Whether the DB snapshot is encrypted.
- Returns:
- Whether the DB snapshot is encrypted.
-
kmsKeyId
If
Encrypted
istrue
, the KMS key identifier for the encrypted DB snapshot.- Returns:
- If
Encrypted
istrue
, the KMS key identifier for the encrypted DB snapshot.
-
timezone
The time zone of the DB snapshot.
- Returns:
- The time zone of the DB snapshot.
-
iamDatabaseAuthenticationEnabled
Whether mapping of IAM accounts to database accounts is enabled.
- Returns:
- Whether mapping of IAM accounts to database accounts is enabled.
-
hasProcessorFeatures
public final boolean hasProcessorFeatures()For responses, this returns true if the service returned a value for the ProcessorFeatures 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. -
processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
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
hasProcessorFeatures()
method.- Returns:
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
-
dbiResourceId
The identifier for the source DB instance.
- Returns:
- The identifier for the source DB instance.
-
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<AwsRdsDbSnapshotDetails.Builder,
AwsRdsDbSnapshotDetails> - 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
-