com.amazonaws.services.rds.model
Class DBInstance

java.lang.Object
  com.amazonaws.services.rds.model.DBInstance

All Implemented Interfaces:

Serializable

public class DBInstance
extends Object
implements Serializable

Contains the result of a successful invocation of the following actions:

• CreateDBInstance
• DeleteDBInstance
• ModifyDBInstance

This data type is used as a response element in the DescribeDBInstances action.

See Also:

Serialized Form

Constructor Summary

DBInstance()

Method Summary

boolean	equals(Object obj)
Integer	getAllocatedStorage() Specifies the allocated storage size specified in gigabytes.
Boolean	getAutoMinorVersionUpgrade() Indicates that minor version patches are applied automatically.
String	getAvailabilityZone() Specifies the name of the Availability Zone the DB Instance is located in.
Integer	getBackupRetentionPeriod() Specifies the number of days for which automatic DB Snapshots are retained.
String	getCharacterSetName() If present, specifies the name of the character set that this instance is associated with.
String	getDBInstanceClass() Contains the name of the compute and memory capacity class of the DB Instance.
String	getDBInstanceIdentifier() Contains a user-supplied database identifier.
String	getDBInstanceStatus() Specifies the current state of this database.
String	getDBName() The meaning of this parameter differs according to the database engine you use.
List<DBParameterGroupStatus>	getDBParameterGroups() Provides the list of DB Parameter Groups applied to this DB Instance.
List<DBSecurityGroupMembership>	getDBSecurityGroups() Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
DBSubnetGroup	getDBSubnetGroup() Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.
Endpoint	getEndpoint() Specifies the connection endpoint.
String	getEngine() Provides the name of the database engine to be used for this DB Instance.
String	getEngineVersion() Indicates the database engine version.
Date	getInstanceCreateTime() Provides the date and time the DB Instance was created.
Integer	getIops() Specifies the Provisioned IOPS (I/O operations per second) value.
Date	getLatestRestorableTime() Specifies the latest time to which a database can be restored with point-in-time restore.
String	getLicenseModel() License model information for this DB Instance.
String	getMasterUsername() Contains the master username for the DB Instance.
Boolean	getMultiAZ() Specifies if the DB Instance is a Multi-AZ deployment.
List<OptionGroupMembership>	getOptionGroupMemberships() Provides the list of option group memberships for this DB Instance.
PendingModifiedValues	getPendingModifiedValues() Specifies that changes to the DB Instance are pending.
String	getPreferredBackupWindow() Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
String	getPreferredMaintenanceWindow() Specifies the weekly time range (in UTC) during which system maintenance can occur.
Boolean	getPubliclyAccessible() Specifies the accessibility options for the DB Instance.
List<String>	getReadReplicaDBInstanceIdentifiers() Contains one or more identifiers of the Read Replicas associated with this DB Instance.
String	getReadReplicaSourceDBInstanceIdentifier() Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.
String	getSecondaryAvailabilityZone() If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
List<VpcSecurityGroupMembership>	getVpcSecurityGroups() Provides List of VPC security group elements that the DB Instance belongs to.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() Indicates that minor version patches are applied automatically.
Boolean	isMultiAZ() Specifies if the DB Instance is a Multi-AZ deployment.
Boolean	isPubliclyAccessible() Specifies the accessibility options for the DB Instance.
void	setAllocatedStorage(Integer allocatedStorage) Specifies the allocated storage size specified in gigabytes.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor version patches are applied automatically.
void	setAvailabilityZone(String availabilityZone) Specifies the name of the Availability Zone the DB Instance is located in.
void	setBackupRetentionPeriod(Integer backupRetentionPeriod) Specifies the number of days for which automatic DB Snapshots are retained.
void	setCharacterSetName(String characterSetName) If present, specifies the name of the character set that this instance is associated with.
void	setDBInstanceClass(String dBInstanceClass) Contains the name of the compute and memory capacity class of the DB Instance.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) Contains a user-supplied database identifier.
void	setDBInstanceStatus(String dBInstanceStatus) Specifies the current state of this database.
void	setDBName(String dBName) The meaning of this parameter differs according to the database engine you use.
void	setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups) Provides the list of DB Parameter Groups applied to this DB Instance.
void	setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups) Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
void	setDBSubnetGroup(DBSubnetGroup dBSubnetGroup) Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.
void	setEndpoint(Endpoint endpoint) Specifies the connection endpoint.
void	setEngine(String engine) Provides the name of the database engine to be used for this DB Instance.
void	setEngineVersion(String engineVersion) Indicates the database engine version.
void	setInstanceCreateTime(Date instanceCreateTime) Provides the date and time the DB Instance was created.
void	setIops(Integer iops) Specifies the Provisioned IOPS (I/O operations per second) value.
void	setLatestRestorableTime(Date latestRestorableTime) Specifies the latest time to which a database can be restored with point-in-time restore.
void	setLicenseModel(String licenseModel) License model information for this DB Instance.
void	setMasterUsername(String masterUsername) Contains the master username for the DB Instance.
void	setMultiAZ(Boolean multiAZ) Specifies if the DB Instance is a Multi-AZ deployment.
void	setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships) Provides the list of option group memberships for this DB Instance.
void	setPendingModifiedValues(PendingModifiedValues pendingModifiedValues) Specifies that changes to the DB Instance are pending.
void	setPreferredBackupWindow(String preferredBackupWindow) Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range (in UTC) during which system maintenance can occur.
void	setPubliclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for the DB Instance.
void	setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers) Contains one or more identifiers of the Read Replicas associated with this DB Instance.
void	setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier) Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.
void	setSecondaryAvailabilityZone(String secondaryAvailabilityZone) If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
void	setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups) Provides List of VPC security group elements that the DB Instance belongs to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DBInstance	withAllocatedStorage(Integer allocatedStorage) Specifies the allocated storage size specified in gigabytes.
DBInstance	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor version patches are applied automatically.
DBInstance	withAvailabilityZone(String availabilityZone) Specifies the name of the Availability Zone the DB Instance is located in.
DBInstance	withBackupRetentionPeriod(Integer backupRetentionPeriod) Specifies the number of days for which automatic DB Snapshots are retained.
DBInstance	withCharacterSetName(String characterSetName) If present, specifies the name of the character set that this instance is associated with.
DBInstance	withDBInstanceClass(String dBInstanceClass) Contains the name of the compute and memory capacity class of the DB Instance.
DBInstance	withDBInstanceIdentifier(String dBInstanceIdentifier) Contains a user-supplied database identifier.
DBInstance	withDBInstanceStatus(String dBInstanceStatus) Specifies the current state of this database.
DBInstance	withDBName(String dBName) The meaning of this parameter differs according to the database engine you use.
DBInstance	withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups) Provides the list of DB Parameter Groups applied to this DB Instance.
DBInstance	withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups) Provides the list of DB Parameter Groups applied to this DB Instance.
DBInstance	withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups) Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
DBInstance	withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups) Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
DBInstance	withDBSubnetGroup(DBSubnetGroup dBSubnetGroup) Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.
DBInstance	withEndpoint(Endpoint endpoint) Specifies the connection endpoint.
DBInstance	withEngine(String engine) Provides the name of the database engine to be used for this DB Instance.
DBInstance	withEngineVersion(String engineVersion) Indicates the database engine version.
DBInstance	withInstanceCreateTime(Date instanceCreateTime) Provides the date and time the DB Instance was created.
DBInstance	withIops(Integer iops) Specifies the Provisioned IOPS (I/O operations per second) value.
DBInstance	withLatestRestorableTime(Date latestRestorableTime) Specifies the latest time to which a database can be restored with point-in-time restore.
DBInstance	withLicenseModel(String licenseModel) License model information for this DB Instance.
DBInstance	withMasterUsername(String masterUsername) Contains the master username for the DB Instance.
DBInstance	withMultiAZ(Boolean multiAZ) Specifies if the DB Instance is a Multi-AZ deployment.
DBInstance	withOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships) Provides the list of option group memberships for this DB Instance.
DBInstance	withOptionGroupMemberships(OptionGroupMembership... optionGroupMemberships) Provides the list of option group memberships for this DB Instance.
DBInstance	withPendingModifiedValues(PendingModifiedValues pendingModifiedValues) Specifies that changes to the DB Instance are pending.
DBInstance	withPreferredBackupWindow(String preferredBackupWindow) Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
DBInstance	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range (in UTC) during which system maintenance can occur.
DBInstance	withPubliclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for the DB Instance.
DBInstance	withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers) Contains one or more identifiers of the Read Replicas associated with this DB Instance.
DBInstance	withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers) Contains one or more identifiers of the Read Replicas associated with this DB Instance.
DBInstance	withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier) Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.
DBInstance	withSecondaryAvailabilityZone(String secondaryAvailabilityZone) If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
DBInstance	withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups) Provides List of VPC security group elements that the DB Instance belongs to.
DBInstance	withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups) Provides List of VPC security group elements that the DB Instance belongs to.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DBInstance

public DBInstance()

Method Detail

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

Returns:

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

Parameters:

dBInstanceIdentifier - Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

withDBInstanceIdentifier

public DBInstance withDBInstanceIdentifier(String dBInstanceIdentifier)

Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBInstanceIdentifier - Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBInstanceClass

public String getDBInstanceClass()

Contains the name of the compute and memory capacity class of the DB Instance.

Returns:

Contains the name of the compute and memory capacity class of the DB Instance.

setDBInstanceClass

public void setDBInstanceClass(String dBInstanceClass)

Contains the name of the compute and memory capacity class of the DB Instance.

Parameters:

dBInstanceClass - Contains the name of the compute and memory capacity class of the DB Instance.

withDBInstanceClass

public DBInstance withDBInstanceClass(String dBInstanceClass)

Contains the name of the compute and memory capacity class of the DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBInstanceClass - Contains the name of the compute and memory capacity class of the DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getEngine

public String getEngine()

Provides the name of the database engine to be used for this DB Instance.

Returns:

Provides the name of the database engine to be used for this DB Instance.

setEngine

public void setEngine(String engine)

Provides the name of the database engine to be used for this DB Instance.

Parameters:

engine - Provides the name of the database engine to be used for this DB Instance.

withEngine

public DBInstance withEngine(String engine)

Provides the name of the database engine to be used for this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

engine - Provides the name of the database engine to be used for this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBInstanceStatus

public String getDBInstanceStatus()

Specifies the current state of this database.

Returns:

Specifies the current state of this database.

setDBInstanceStatus

public void setDBInstanceStatus(String dBInstanceStatus)

Specifies the current state of this database.

Parameters:

dBInstanceStatus - Specifies the current state of this database.

withDBInstanceStatus

public DBInstance withDBInstanceStatus(String dBInstanceStatus)

Specifies the current state of this database.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBInstanceStatus - Specifies the current state of this database.

Returns:

A reference to this updated object so that method calls can be chained together.

getMasterUsername

public String getMasterUsername()

Contains the master username for the DB Instance.

Returns:

Contains the master username for the DB Instance.

setMasterUsername

public void setMasterUsername(String masterUsername)

Contains the master username for the DB Instance.

Parameters:

masterUsername - Contains the master username for the DB Instance.

withMasterUsername

public DBInstance withMasterUsername(String masterUsername)

Contains the master username for the DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

masterUsername - Contains the master username for the DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBName

public String getDBName()

The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

Returns:

The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

setDBName

public void setDBName(String dBName)

The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

Parameters:

dBName - The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

withDBName

public DBInstance withDBName(String dBName)

The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBName - The meaning of this parameter differs according to the database engine you use.

MySQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndpoint

public Endpoint getEndpoint()

Specifies the connection endpoint.

Returns:

Specifies the connection endpoint.

setEndpoint

public void setEndpoint(Endpoint endpoint)

Specifies the connection endpoint.

Parameters:

endpoint - Specifies the connection endpoint.

withEndpoint

public DBInstance withEndpoint(Endpoint endpoint)

Specifies the connection endpoint.

Returns a reference to this object so that method calls can be chained together.

Parameters:

endpoint - Specifies the connection endpoint.

Returns:

A reference to this updated object so that method calls can be chained together.

getAllocatedStorage

public Integer getAllocatedStorage()

Specifies the allocated storage size specified in gigabytes.

Returns:

Specifies the allocated storage size specified in gigabytes.

setAllocatedStorage

public void setAllocatedStorage(Integer allocatedStorage)

Specifies the allocated storage size specified in gigabytes.

Parameters:

allocatedStorage - Specifies the allocated storage size specified in gigabytes.

withAllocatedStorage

public DBInstance withAllocatedStorage(Integer allocatedStorage)

Specifies the allocated storage size specified in gigabytes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

allocatedStorage - Specifies the allocated storage size specified in gigabytes.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceCreateTime

public Date getInstanceCreateTime()

Provides the date and time the DB Instance was created.

Returns:

Provides the date and time the DB Instance was created.

setInstanceCreateTime

public void setInstanceCreateTime(Date instanceCreateTime)

Provides the date and time the DB Instance was created.

Parameters:

instanceCreateTime - Provides the date and time the DB Instance was created.

withInstanceCreateTime

public DBInstance withInstanceCreateTime(Date instanceCreateTime)

Provides the date and time the DB Instance was created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceCreateTime - Provides the date and time the DB Instance was created.

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredBackupWindow

public String getPreferredBackupWindow()

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Returns:

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

setPreferredBackupWindow

public void setPreferredBackupWindow(String preferredBackupWindow)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Parameters:

preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

withPreferredBackupWindow

public DBInstance withPreferredBackupWindow(String preferredBackupWindow)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Returns a reference to this object so that method calls can be chained together.

Parameters:

preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Returns:

A reference to this updated object so that method calls can be chained together.

getBackupRetentionPeriod

public Integer getBackupRetentionPeriod()

Specifies the number of days for which automatic DB Snapshots are retained.

Returns:

Specifies the number of days for which automatic DB Snapshots are retained.

setBackupRetentionPeriod

public void setBackupRetentionPeriod(Integer backupRetentionPeriod)

Specifies the number of days for which automatic DB Snapshots are retained.

Parameters:

backupRetentionPeriod - Specifies the number of days for which automatic DB Snapshots are retained.

withBackupRetentionPeriod

public DBInstance withBackupRetentionPeriod(Integer backupRetentionPeriod)

Specifies the number of days for which automatic DB Snapshots are retained.

Returns a reference to this object so that method calls can be chained together.

Parameters:

backupRetentionPeriod - Specifies the number of days for which automatic DB Snapshots are retained.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBSecurityGroups

public List<DBSecurityGroupMembership> getDBSecurityGroups()

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Returns:

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

setDBSecurityGroups

public void setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Parameters:

dBSecurityGroups - Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

withDBSecurityGroups

public DBInstance withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBSecurityGroups - Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Returns:

A reference to this updated object so that method calls can be chained together.

withDBSecurityGroups

public DBInstance withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBSecurityGroups - Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Returns:

A reference to this updated object so that method calls can be chained together.

getVpcSecurityGroups

public List<VpcSecurityGroupMembership> getVpcSecurityGroups()

Provides List of VPC security group elements that the DB Instance belongs to.

Returns:

Provides List of VPC security group elements that the DB Instance belongs to.

setVpcSecurityGroups

public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

Provides List of VPC security group elements that the DB Instance belongs to.

Parameters:

vpcSecurityGroups - Provides List of VPC security group elements that the DB Instance belongs to.

withVpcSecurityGroups

public DBInstance withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)

Provides List of VPC security group elements that the DB Instance belongs to.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vpcSecurityGroups - Provides List of VPC security group elements that the DB Instance belongs to.

Returns:

A reference to this updated object so that method calls can be chained together.

withVpcSecurityGroups

public DBInstance withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

Provides List of VPC security group elements that the DB Instance belongs to.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vpcSecurityGroups - Provides List of VPC security group elements that the DB Instance belongs to.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBParameterGroups

public List<DBParameterGroupStatus> getDBParameterGroups()

Provides the list of DB Parameter Groups applied to this DB Instance.

Returns:

Provides the list of DB Parameter Groups applied to this DB Instance.

setDBParameterGroups

public void setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)

Provides the list of DB Parameter Groups applied to this DB Instance.

Parameters:

dBParameterGroups - Provides the list of DB Parameter Groups applied to this DB Instance.

withDBParameterGroups

public DBInstance withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups)

Provides the list of DB Parameter Groups applied to this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBParameterGroups - Provides the list of DB Parameter Groups applied to this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

withDBParameterGroups

public DBInstance withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)

Provides the list of DB Parameter Groups applied to this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBParameterGroups - Provides the list of DB Parameter Groups applied to this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

public String getAvailabilityZone()

Specifies the name of the Availability Zone the DB Instance is located in.

Returns:

Specifies the name of the Availability Zone the DB Instance is located in.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

Specifies the name of the Availability Zone the DB Instance is located in.

Parameters:

availabilityZone - Specifies the name of the Availability Zone the DB Instance is located in.

withAvailabilityZone

public DBInstance withAvailabilityZone(String availabilityZone)

Specifies the name of the Availability Zone the DB Instance is located in.

Returns a reference to this object so that method calls can be chained together.

Parameters:

availabilityZone - Specifies the name of the Availability Zone the DB Instance is located in.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBSubnetGroup

public DBSubnetGroup getDBSubnetGroup()

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

Returns:

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

setDBSubnetGroup

public void setDBSubnetGroup(DBSubnetGroup dBSubnetGroup)

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

Parameters:

dBSubnetGroup - Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

withDBSubnetGroup

public DBInstance withDBSubnetGroup(DBSubnetGroup dBSubnetGroup)

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBSubnetGroup - Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

Specifies the weekly time range (in UTC) during which system maintenance can occur.

Returns:

Specifies the weekly time range (in UTC) during which system maintenance can occur.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

Specifies the weekly time range (in UTC) during which system maintenance can occur.

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range (in UTC) during which system maintenance can occur.

withPreferredMaintenanceWindow

public DBInstance withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

Specifies the weekly time range (in UTC) during which system maintenance can occur.

Returns a reference to this object so that method calls can be chained together.

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range (in UTC) during which system maintenance can occur.

Returns:

A reference to this updated object so that method calls can be chained together.

getPendingModifiedValues

public PendingModifiedValues getPendingModifiedValues()

Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Returns:

Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

setPendingModifiedValues

public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)

Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Parameters:

pendingModifiedValues - Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

withPendingModifiedValues

public DBInstance withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)

Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Returns a reference to this object so that method calls can be chained together.

Parameters:

pendingModifiedValues - Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Returns:

A reference to this updated object so that method calls can be chained together.

getLatestRestorableTime

public Date getLatestRestorableTime()

Specifies the latest time to which a database can be restored with point-in-time restore.

Returns:

Specifies the latest time to which a database can be restored with point-in-time restore.

setLatestRestorableTime

public void setLatestRestorableTime(Date latestRestorableTime)

Specifies the latest time to which a database can be restored with point-in-time restore.

Parameters:

latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

withLatestRestorableTime

public DBInstance withLatestRestorableTime(Date latestRestorableTime)

Specifies the latest time to which a database can be restored with point-in-time restore.

Returns a reference to this object so that method calls can be chained together.

Parameters:

latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

Returns:

A reference to this updated object so that method calls can be chained together.

isMultiAZ

public Boolean isMultiAZ()

Specifies if the DB Instance is a Multi-AZ deployment.

Returns:

Specifies if the DB Instance is a Multi-AZ deployment.

setMultiAZ

public void setMultiAZ(Boolean multiAZ)

Specifies if the DB Instance is a Multi-AZ deployment.

Parameters:

multiAZ - Specifies if the DB Instance is a Multi-AZ deployment.

withMultiAZ

public DBInstance withMultiAZ(Boolean multiAZ)

Specifies if the DB Instance is a Multi-AZ deployment.

Returns a reference to this object so that method calls can be chained together.

Parameters:

multiAZ - Specifies if the DB Instance is a Multi-AZ deployment.

Returns:

A reference to this updated object so that method calls can be chained together.

getMultiAZ

public Boolean getMultiAZ()

Specifies if the DB Instance is a Multi-AZ deployment.

Returns:

Specifies if the DB Instance is a Multi-AZ deployment.

getEngineVersion

public String getEngineVersion()

Indicates the database engine version.

Returns:

Indicates the database engine version.

setEngineVersion

public void setEngineVersion(String engineVersion)

Indicates the database engine version.

Parameters:

engineVersion - Indicates the database engine version.

withEngineVersion

public DBInstance withEngineVersion(String engineVersion)

Indicates the database engine version.

Returns a reference to this object so that method calls can be chained together.

Parameters:

engineVersion - Indicates the database engine version.

Returns:

A reference to this updated object so that method calls can be chained together.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

Indicates that minor version patches are applied automatically.

Returns:

Indicates that minor version patches are applied automatically.

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor version patches are applied automatically.

Parameters:

autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically.

withAutoMinorVersionUpgrade

public DBInstance withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor version patches are applied automatically.

Returns a reference to this object so that method calls can be chained together.

Parameters:

autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically.

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

Indicates that minor version patches are applied automatically.

Returns:

Indicates that minor version patches are applied automatically.

getReadReplicaSourceDBInstanceIdentifier

public String getReadReplicaSourceDBInstanceIdentifier()

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

Returns:

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

setReadReplicaSourceDBInstanceIdentifier

public void setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

Parameters:

readReplicaSourceDBInstanceIdentifier - Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

withReadReplicaSourceDBInstanceIdentifier

public DBInstance withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

Returns a reference to this object so that method calls can be chained together.

Parameters:

readReplicaSourceDBInstanceIdentifier - Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

Returns:

A reference to this updated object so that method calls can be chained together.

getReadReplicaDBInstanceIdentifiers

public List<String> getReadReplicaDBInstanceIdentifiers()

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

Returns:

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

setReadReplicaDBInstanceIdentifiers

public void setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

Parameters:

readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB Instance.

withReadReplicaDBInstanceIdentifiers

public DBInstance withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

withReadReplicaDBInstanceIdentifiers

public DBInstance withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getLicenseModel

public String getLicenseModel()

License model information for this DB Instance.

Returns:

License model information for this DB Instance.

setLicenseModel

public void setLicenseModel(String licenseModel)

License model information for this DB Instance.

Parameters:

licenseModel - License model information for this DB Instance.

withLicenseModel

public DBInstance withLicenseModel(String licenseModel)

License model information for this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

licenseModel - License model information for this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getIops

public Integer getIops()

Specifies the Provisioned IOPS (I/O operations per second) value.

Returns:

Specifies the Provisioned IOPS (I/O operations per second) value.

setIops

public void setIops(Integer iops)

Specifies the Provisioned IOPS (I/O operations per second) value.

Parameters:

iops - Specifies the Provisioned IOPS (I/O operations per second) value.

withIops

public DBInstance withIops(Integer iops)

Specifies the Provisioned IOPS (I/O operations per second) value.

Returns a reference to this object so that method calls can be chained together.

Parameters:

iops - Specifies the Provisioned IOPS (I/O operations per second) value.

Returns:

A reference to this updated object so that method calls can be chained together.

getOptionGroupMemberships

public List<OptionGroupMembership> getOptionGroupMemberships()

Provides the list of option group memberships for this DB Instance.

Returns:

Provides the list of option group memberships for this DB Instance.

setOptionGroupMemberships

public void setOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)

Provides the list of option group memberships for this DB Instance.

Parameters:

optionGroupMemberships - Provides the list of option group memberships for this DB Instance.

withOptionGroupMemberships

public DBInstance withOptionGroupMemberships(OptionGroupMembership... optionGroupMemberships)

Provides the list of option group memberships for this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

optionGroupMemberships - Provides the list of option group memberships for this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

withOptionGroupMemberships

public DBInstance withOptionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)

Provides the list of option group memberships for this DB Instance.

Returns a reference to this object so that method calls can be chained together.

Parameters:

optionGroupMemberships - Provides the list of option group memberships for this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getCharacterSetName

public String getCharacterSetName()

If present, specifies the name of the character set that this instance is associated with.

Returns:

If present, specifies the name of the character set that this instance is associated with.

setCharacterSetName

public void setCharacterSetName(String characterSetName)

If present, specifies the name of the character set that this instance is associated with.

Parameters:

characterSetName - If present, specifies the name of the character set that this instance is associated with.

withCharacterSetName

public DBInstance withCharacterSetName(String characterSetName)

If present, specifies the name of the character set that this instance is associated with.

Returns a reference to this object so that method calls can be chained together.

Parameters:

characterSetName - If present, specifies the name of the character set that this instance is associated with.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecondaryAvailabilityZone

public String getSecondaryAvailabilityZone()

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Returns:

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

setSecondaryAvailabilityZone

public void setSecondaryAvailabilityZone(String secondaryAvailabilityZone)

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Parameters:

secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

withSecondaryAvailabilityZone

public DBInstance withSecondaryAvailabilityZone(String secondaryAvailabilityZone)

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Returns a reference to this object so that method calls can be chained together.

Parameters:

secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Returns:

A reference to this updated object so that method calls can be chained together.

isPubliclyAccessible

public Boolean isPubliclyAccessible()

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Returns:

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

setPubliclyAccessible

public void setPubliclyAccessible(Boolean publiclyAccessible)

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Parameters:

publiclyAccessible - Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

withPubliclyAccessible

public DBInstance withPubliclyAccessible(Boolean publiclyAccessible)

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Returns a reference to this object so that method calls can be chained together.

Parameters:

publiclyAccessible - Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Returns:

A reference to this updated object so that method calls can be chained together.

getPubliclyAccessible

public Boolean getPubliclyAccessible()

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

Returns:

Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true
• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object