@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBSnapshot extends Object implements Serializable, Cloneable
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
Constructor and Description |
---|
DBSnapshot() |
Modifier and Type | Method and Description |
---|---|
DBSnapshot |
clone() |
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
Specifies the allocated storage size in gigabytes (GB).
|
String |
getAvailabilityZone()
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
|
String |
getDBInstanceIdentifier()
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
|
String |
getDBSnapshotArn()
The Amazon Resource Name (ARN) for the DB snapshot.
|
String |
getDBSnapshotIdentifier()
Specifies the identifier for the DB snapshot.
|
Boolean |
getEncrypted()
Specifies whether the DB snapshot is encrypted.
|
String |
getEngine()
Specifies the name of the database engine.
|
String |
getEngineVersion()
Specifies the version of the database engine.
|
Boolean |
getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
Date |
getInstanceCreateTime()
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
|
Integer |
getIops()
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
|
String |
getKmsKeyId()
If
Encrypted is true, the KMS key identifier for the encrypted DB snapshot. |
String |
getLicenseModel()
License model information for the restored DB instance.
|
String |
getMasterUsername()
Provides the master username for the DB snapshot.
|
String |
getOptionGroupName()
Provides the option group name for the DB snapshot.
|
Integer |
getPercentProgress()
The percentage of the estimated data that has been transferred.
|
Integer |
getPort()
Specifies the port that the database engine was listening on at the time of the snapshot.
|
Date |
getSnapshotCreateTime()
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
|
String |
getSnapshotType()
Provides the type of the DB snapshot.
|
String |
getSourceDBSnapshotIdentifier()
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.
|
String |
getSourceRegion()
The AWS Region that the DB snapshot was created in or copied from.
|
String |
getStatus()
Specifies the status of this DB snapshot.
|
String |
getStorageType()
Specifies the storage type associated with DB snapshot.
|
String |
getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
getTimezone()
The time zone of the DB snapshot.
|
String |
getVpcId()
Provides the VPC ID associated with the DB snapshot.
|
int |
hashCode() |
Boolean |
isEncrypted()
Specifies whether the DB snapshot is encrypted.
|
Boolean |
isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
void |
setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gigabytes (GB).
|
void |
setAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
|
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
|
void |
setDBSnapshotArn(String dBSnapshotArn)
The Amazon Resource Name (ARN) for the DB snapshot.
|
void |
setDBSnapshotIdentifier(String dBSnapshotIdentifier)
Specifies the identifier for the DB snapshot.
|
void |
setEncrypted(Boolean encrypted)
Specifies whether the DB snapshot is encrypted.
|
void |
setEngine(String engine)
Specifies the name of the database engine.
|
void |
setEngineVersion(String engineVersion)
Specifies the version of the database engine.
|
void |
setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
void |
setInstanceCreateTime(Date instanceCreateTime)
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
|
void |
setIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
|
void |
setKmsKeyId(String kmsKeyId)
If
Encrypted is true, the KMS key identifier for the encrypted DB snapshot. |
void |
setLicenseModel(String licenseModel)
License model information for the restored DB instance.
|
void |
setMasterUsername(String masterUsername)
Provides the master username for the DB snapshot.
|
void |
setOptionGroupName(String optionGroupName)
Provides the option group name for the DB snapshot.
|
void |
setPercentProgress(Integer percentProgress)
The percentage of the estimated data that has been transferred.
|
void |
setPort(Integer port)
Specifies the port that the database engine was listening on at the time of the snapshot.
|
void |
setSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
|
void |
setSnapshotType(String snapshotType)
Provides the type of the DB snapshot.
|
void |
setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.
|
void |
setSourceRegion(String sourceRegion)
The AWS Region that the DB snapshot was created in or copied from.
|
void |
setStatus(String status)
Specifies the status of this DB snapshot.
|
void |
setStorageType(String storageType)
Specifies the storage type associated with DB snapshot.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
void |
setTimezone(String timezone)
The time zone of the DB snapshot.
|
void |
setVpcId(String vpcId)
Provides the VPC ID associated with the DB snapshot.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
DBSnapshot |
withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gigabytes (GB).
|
DBSnapshot |
withAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
|
DBSnapshot |
withDBInstanceIdentifier(String dBInstanceIdentifier)
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
|
DBSnapshot |
withDBSnapshotArn(String dBSnapshotArn)
The Amazon Resource Name (ARN) for the DB snapshot.
|
DBSnapshot |
withDBSnapshotIdentifier(String dBSnapshotIdentifier)
Specifies the identifier for the DB snapshot.
|
DBSnapshot |
withEncrypted(Boolean encrypted)
Specifies whether the DB snapshot is encrypted.
|
DBSnapshot |
withEngine(String engine)
Specifies the name of the database engine.
|
DBSnapshot |
withEngineVersion(String engineVersion)
Specifies the version of the database engine.
|
DBSnapshot |
withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
DBSnapshot |
withInstanceCreateTime(Date instanceCreateTime)
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
|
DBSnapshot |
withIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
|
DBSnapshot |
withKmsKeyId(String kmsKeyId)
If
Encrypted is true, the KMS key identifier for the encrypted DB snapshot. |
DBSnapshot |
withLicenseModel(String licenseModel)
License model information for the restored DB instance.
|
DBSnapshot |
withMasterUsername(String masterUsername)
Provides the master username for the DB snapshot.
|
DBSnapshot |
withOptionGroupName(String optionGroupName)
Provides the option group name for the DB snapshot.
|
DBSnapshot |
withPercentProgress(Integer percentProgress)
The percentage of the estimated data that has been transferred.
|
DBSnapshot |
withPort(Integer port)
Specifies the port that the database engine was listening on at the time of the snapshot.
|
DBSnapshot |
withSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
|
DBSnapshot |
withSnapshotType(String snapshotType)
Provides the type of the DB snapshot.
|
DBSnapshot |
withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.
|
DBSnapshot |
withSourceRegion(String sourceRegion)
The AWS Region that the DB snapshot was created in or copied from.
|
DBSnapshot |
withStatus(String status)
Specifies the status of this DB snapshot.
|
DBSnapshot |
withStorageType(String storageType)
Specifies the storage type associated with DB snapshot.
|
DBSnapshot |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
DBSnapshot |
withTimezone(String timezone)
The time zone of the DB snapshot.
|
DBSnapshot |
withVpcId(String vpcId)
Provides the VPC ID associated with the DB snapshot.
|
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
Specifies the identifier for the DB snapshot.
dBSnapshotIdentifier
- Specifies the identifier for the DB snapshot.public String getDBSnapshotIdentifier()
Specifies the identifier for the DB snapshot.
public DBSnapshot withDBSnapshotIdentifier(String dBSnapshotIdentifier)
Specifies the identifier for the DB snapshot.
dBSnapshotIdentifier
- Specifies the identifier for the DB snapshot.public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
dBInstanceIdentifier
- Specifies the DB instance identifier of the DB instance this DB snapshot was created from.public String getDBInstanceIdentifier()
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
public DBSnapshot withDBInstanceIdentifier(String dBInstanceIdentifier)
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
dBInstanceIdentifier
- Specifies the DB instance identifier of the DB instance this DB snapshot was created from.public void setSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).public Date getSnapshotCreateTime()
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
public DBSnapshot withSnapshotCreateTime(Date snapshotCreateTime)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
snapshotCreateTime
- Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).public void setEngine(String engine)
Specifies the name of the database engine.
engine
- Specifies the name of the database engine.public String getEngine()
Specifies the name of the database engine.
public DBSnapshot withEngine(String engine)
Specifies the name of the database engine.
engine
- Specifies the name of the database engine.public void setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gigabytes (GB).
allocatedStorage
- Specifies the allocated storage size in gigabytes (GB).public Integer getAllocatedStorage()
Specifies the allocated storage size in gigabytes (GB).
public DBSnapshot withAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gigabytes (GB).
allocatedStorage
- Specifies the allocated storage size in gigabytes (GB).public void setStatus(String status)
Specifies the status of this DB snapshot.
status
- Specifies the status of this DB snapshot.public String getStatus()
Specifies the status of this DB snapshot.
public DBSnapshot withStatus(String status)
Specifies the status of this DB snapshot.
status
- Specifies the status of this DB snapshot.public void setPort(Integer port)
Specifies the port that the database engine was listening on at the time of the snapshot.
port
- Specifies the port that the database engine was listening on at the time of the snapshot.public Integer getPort()
Specifies the port that the database engine was listening on at the time of the snapshot.
public DBSnapshot withPort(Integer port)
Specifies the port that the database engine was listening on at the time of the snapshot.
port
- Specifies the port that the database engine was listening on at the time of the snapshot.public void setAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
availabilityZone
- Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.public String getAvailabilityZone()
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
public DBSnapshot withAvailabilityZone(String availabilityZone)
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
availabilityZone
- Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.public void setVpcId(String vpcId)
Provides the VPC ID associated with the DB snapshot.
vpcId
- Provides the VPC ID associated with the DB snapshot.public String getVpcId()
Provides the VPC ID associated with the DB snapshot.
public DBSnapshot withVpcId(String vpcId)
Provides the VPC ID associated with the DB snapshot.
vpcId
- Provides the VPC ID associated with the DB snapshot.public void setInstanceCreateTime(Date instanceCreateTime)
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
instanceCreateTime
- Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).public Date getInstanceCreateTime()
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
public DBSnapshot withInstanceCreateTime(Date instanceCreateTime)
Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
instanceCreateTime
- Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).public void setMasterUsername(String masterUsername)
Provides the master username for the DB snapshot.
masterUsername
- Provides the master username for the DB snapshot.public String getMasterUsername()
Provides the master username for the DB snapshot.
public DBSnapshot withMasterUsername(String masterUsername)
Provides the master username for the DB snapshot.
masterUsername
- Provides the master username for the DB snapshot.public void setEngineVersion(String engineVersion)
Specifies the version of the database engine.
engineVersion
- Specifies the version of the database engine.public String getEngineVersion()
Specifies the version of the database engine.
public DBSnapshot withEngineVersion(String engineVersion)
Specifies the version of the database engine.
engineVersion
- Specifies the version of the database engine.public void setLicenseModel(String licenseModel)
License model information for the restored DB instance.
licenseModel
- License model information for the restored DB instance.public String getLicenseModel()
License model information for the restored DB instance.
public DBSnapshot withLicenseModel(String licenseModel)
License model information for the restored DB instance.
licenseModel
- License model information for the restored DB instance.public void setSnapshotType(String snapshotType)
Provides the type of the DB snapshot.
snapshotType
- Provides the type of the DB snapshot.public String getSnapshotType()
Provides the type of the DB snapshot.
public DBSnapshot withSnapshotType(String snapshotType)
Provides the type of the DB snapshot.
snapshotType
- Provides the type of the DB snapshot.public void setIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the
snapshot.public Integer getIops()
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
public DBSnapshot withIops(Integer iops)
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
iops
- Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the
snapshot.public void setOptionGroupName(String optionGroupName)
Provides the option group name for the DB snapshot.
optionGroupName
- Provides the option group name for the DB snapshot.public String getOptionGroupName()
Provides the option group name for the DB snapshot.
public DBSnapshot withOptionGroupName(String optionGroupName)
Provides the option group name for the DB snapshot.
optionGroupName
- Provides the option group name for the DB snapshot.public void setPercentProgress(Integer percentProgress)
The percentage of the estimated data that has been transferred.
percentProgress
- The percentage of the estimated data that has been transferred.public Integer getPercentProgress()
The percentage of the estimated data that has been transferred.
public DBSnapshot withPercentProgress(Integer percentProgress)
The percentage of the estimated data that has been transferred.
percentProgress
- The percentage of the estimated data that has been transferred.public void setSourceRegion(String sourceRegion)
The AWS Region that the DB snapshot was created in or copied from.
sourceRegion
- The AWS Region that the DB snapshot was created in or copied from.public String getSourceRegion()
The AWS Region that the DB snapshot was created in or copied from.
public DBSnapshot withSourceRegion(String sourceRegion)
The AWS Region that the DB snapshot was created in or copied from.
sourceRegion
- The AWS Region that the DB snapshot was created in or copied from.public void setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
sourceDBSnapshotIdentifier
- The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case
of cross-customer or cross-region copy.public String getSourceDBSnapshotIdentifier()
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
public DBSnapshot withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier)
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
sourceDBSnapshotIdentifier
- The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case
of cross-customer or cross-region copy.public void setStorageType(String storageType)
Specifies the storage type associated with DB snapshot.
storageType
- Specifies the storage type associated with DB snapshot.public String getStorageType()
Specifies the storage type associated with DB snapshot.
public DBSnapshot withStorageType(String storageType)
Specifies the storage type associated with DB snapshot.
storageType
- Specifies the storage type associated with DB snapshot.public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.public String getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public DBSnapshot withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.public void setEncrypted(Boolean encrypted)
Specifies whether the DB snapshot is encrypted.
encrypted
- Specifies whether the DB snapshot is encrypted.public Boolean getEncrypted()
Specifies whether the DB snapshot is encrypted.
public DBSnapshot withEncrypted(Boolean encrypted)
Specifies whether the DB snapshot is encrypted.
encrypted
- Specifies whether the DB snapshot is encrypted.public Boolean isEncrypted()
Specifies whether the DB snapshot is encrypted.
public void setKmsKeyId(String kmsKeyId)
If Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.
kmsKeyId
- If Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.public String getKmsKeyId()
If Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.
Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.public DBSnapshot withKmsKeyId(String kmsKeyId)
If Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.
kmsKeyId
- If Encrypted
is true, the KMS key identifier for the encrypted DB snapshot.public void setDBSnapshotArn(String dBSnapshotArn)
The Amazon Resource Name (ARN) for the DB snapshot.
dBSnapshotArn
- The Amazon Resource Name (ARN) for the DB snapshot.public String getDBSnapshotArn()
The Amazon Resource Name (ARN) for the DB snapshot.
public DBSnapshot withDBSnapshotArn(String dBSnapshotArn)
The Amazon Resource Name (ARN) for the DB snapshot.
dBSnapshotArn
- The Amazon Resource Name (ARN) for the DB snapshot.public void setTimezone(String timezone)
The time zone of the DB snapshot. In most cases, the Timezone
element is empty.
Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that were
created with a time zone specified.
timezone
- The time zone of the DB snapshot. In most cases, the Timezone
element is empty.
Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that
were created with a time zone specified.public String getTimezone()
The time zone of the DB snapshot. In most cases, the Timezone
element is empty.
Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that were
created with a time zone specified.
Timezone
element is empty.
Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances
that were created with a time zone specified.public DBSnapshot withTimezone(String timezone)
The time zone of the DB snapshot. In most cases, the Timezone
element is empty.
Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that were
created with a time zone specified.
timezone
- The time zone of the DB snapshot. In most cases, the Timezone
element is empty.
Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that
were created with a time zone specified.public void setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled;
otherwise false.public Boolean getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
public DBSnapshot withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled;
otherwise false.public Boolean isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
public String toString()
toString
in class Object
Object.toString()
public DBSnapshot clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.