|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.services.rds.model.DBInstance
public class DBInstance
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
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 |
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. |
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. |
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. |
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. |
int |
hashCode()
|
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor version patches are applied automatically. |
Boolean |
isMultiAZ()
Specifies if the DB Instance is a Multi-AZ deployment. |
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 |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
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 |
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. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DBInstance()
Method Detail |
---|
public String getDBInstanceIdentifier()
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
dBInstanceIdentifier
- Contains a user-supplied database identifier. This is the unique key
that identifies a DB Instance.public DBInstance withDBInstanceIdentifier(String dBInstanceIdentifier)
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier
- Contains a user-supplied database identifier. This is the unique key
that identifies a DB Instance.
public String getDBInstanceClass()
public void setDBInstanceClass(String dBInstanceClass)
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB
Instance.public DBInstance withDBInstanceClass(String dBInstanceClass)
Returns a reference to this object so that method calls can be chained together.
dBInstanceClass
- Contains the name of the compute and memory capacity class of the DB
Instance.
public String getEngine()
public void setEngine(String engine)
engine
- Provides the name of the database engine to be used for this DB
Instance.public DBInstance withEngine(String engine)
Returns a reference to this object so that method calls can be chained together.
engine
- Provides the name of the database engine to be used for this DB
Instance.
public String getDBInstanceStatus()
public void setDBInstanceStatus(String dBInstanceStatus)
dBInstanceStatus
- Specifies the current state of this database.public DBInstance withDBInstanceStatus(String dBInstanceStatus)
Returns a reference to this object so that method calls can be chained together.
dBInstanceStatus
- Specifies the current state of this database.
public String getMasterUsername()
public void setMasterUsername(String masterUsername)
masterUsername
- Contains the master username for the DB Instance.public DBInstance withMasterUsername(String masterUsername)
Returns a reference to this object so that method calls can be chained together.
masterUsername
- Contains the master username for the DB Instance.
public String getDBName()
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.
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.
public void setDBName(String dBName)
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.
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.
public DBInstance withDBName(String dBName)
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.
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.
public Endpoint getEndpoint()
public void setEndpoint(Endpoint endpoint)
endpoint
- Specifies the connection endpoint.public DBInstance withEndpoint(Endpoint endpoint)
Returns a reference to this object so that method calls can be chained together.
endpoint
- Specifies the connection endpoint.
public Integer getAllocatedStorage()
public void setAllocatedStorage(Integer allocatedStorage)
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.public DBInstance withAllocatedStorage(Integer allocatedStorage)
Returns a reference to this object so that method calls can be chained together.
allocatedStorage
- Specifies the allocated storage size specified in gigabytes.
public Date getInstanceCreateTime()
public void setInstanceCreateTime(Date instanceCreateTime)
instanceCreateTime
- Provides the date and time the DB Instance was created.public DBInstance withInstanceCreateTime(Date instanceCreateTime)
Returns a reference to this object so that method calls can be chained together.
instanceCreateTime
- Provides the date and time the DB Instance was created.
public String getPreferredBackupWindow()
BackupRetentionPeriod
.
BackupRetentionPeriod
.public void setPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.public DBInstance withPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
.
Returns a reference to this object so that method calls can be chained together.
preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.
public Integer getBackupRetentionPeriod()
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
backupRetentionPeriod
- Specifies the number of days for which automatic DB Snapshots are
retained.public DBInstance withBackupRetentionPeriod(Integer backupRetentionPeriod)
Returns a reference to this object so that method calls can be chained together.
backupRetentionPeriod
- Specifies the number of days for which automatic DB Snapshots are
retained.
public List<DBSecurityGroupMembership> getDBSecurityGroups()
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public void setDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
dBSecurityGroups
- Provides List of DB Security Group elements containing only
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.public DBInstance withDBSecurityGroups(DBSecurityGroupMembership... dBSecurityGroups)
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- Provides List of DB Security Group elements containing only
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
public DBInstance withDBSecurityGroups(Collection<DBSecurityGroupMembership> dBSecurityGroups)
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- Provides List of DB Security Group elements containing only
DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
public List<DBParameterGroupStatus> getDBParameterGroups()
public void setDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
dBParameterGroups
- Provides the list of DB Parameter Groups applied to this DB Instance.public DBInstance withDBParameterGroups(DBParameterGroupStatus... dBParameterGroups)
Returns a reference to this object so that method calls can be chained together.
dBParameterGroups
- Provides the list of DB Parameter Groups applied to this DB Instance.
public DBInstance withDBParameterGroups(Collection<DBParameterGroupStatus> dBParameterGroups)
Returns a reference to this object so that method calls can be chained together.
dBParameterGroups
- Provides the list of DB Parameter Groups applied to this DB Instance.
public String getAvailabilityZone()
public void setAvailabilityZone(String availabilityZone)
availabilityZone
- Specifies the name of the Availability Zone the DB Instance is located
in.public DBInstance withAvailabilityZone(String availabilityZone)
Returns a reference to this object so that method calls can be chained together.
availabilityZone
- Specifies the name of the Availability Zone the DB Instance is located
in.
public DBSubnetGroup getDBSubnetGroup()
public void setDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
dBSubnetGroup
- Provides the inforamtion of the subnet group associated with the DB
instance, including the name, descrption and subnets in the subnet
group.public DBInstance withDBSubnetGroup(DBSubnetGroup dBSubnetGroup)
Returns a reference to this object so that method calls can be chained together.
dBSubnetGroup
- Provides the inforamtion of the subnet group associated with the DB
instance, including the name, descrption and subnets in the subnet
group.
public String getPreferredMaintenanceWindow()
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
preferredMaintenanceWindow
- Specifies the weekly time range (in UTC) during which system
maintenance can occur.public DBInstance withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- Specifies the weekly time range (in UTC) during which system
maintenance can occur.
public PendingModifiedValues getPendingModifiedValues()
public void setPendingModifiedValues(PendingModifiedValues 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.public DBInstance withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Returns a reference to this object so that method calls can be chained together.
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.
public Date getLatestRestorableTime()
public void setLatestRestorableTime(Date latestRestorableTime)
latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.public DBInstance withLatestRestorableTime(Date latestRestorableTime)
Returns a reference to this object so that method calls can be chained together.
latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
public Boolean isMultiAZ()
public void setMultiAZ(Boolean multiAZ)
multiAZ
- Specifies if the DB Instance is a Multi-AZ deployment.public DBInstance withMultiAZ(Boolean multiAZ)
Returns a reference to this object so that method calls can be chained together.
multiAZ
- Specifies if the DB Instance is a Multi-AZ deployment.
public Boolean getMultiAZ()
public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- Indicates the database engine version.public DBInstance withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- Indicates the database engine version.
public Boolean isAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.public DBInstance withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Indicates that minor version patches are applied automatically.
public Boolean getAutoMinorVersionUpgrade()
public String getReadReplicaSourceDBInstanceIdentifier()
public void setReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB Instance if this DB Instance
is a Read Replica.public DBInstance withReadReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
Returns a reference to this object so that method calls can be chained together.
readReplicaSourceDBInstanceIdentifier
- Contains the identifier of the source DB Instance if this DB Instance
is a Read Replica.
public List<String> getReadReplicaDBInstanceIdentifiers()
public void setReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB Instance.public DBInstance withReadReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
Returns a reference to this object so that method calls can be chained together.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB Instance.
public DBInstance withReadReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
Returns a reference to this object so that method calls can be chained together.
readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the Read Replicas associated with
this DB Instance.
public String getLicenseModel()
public void setLicenseModel(String licenseModel)
licenseModel
- License model information for this DB Instance.public DBInstance withLicenseModel(String licenseModel)
Returns a reference to this object so that method calls can be chained together.
licenseModel
- License model information for this DB Instance.
public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |