|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.rds.model.ModifyDBInstanceRequest
public class ModifyDBInstanceRequest
Container for the parameters to the ModifyDBInstance operation
.
This API is used to change RDS Instance settings. Users call the ModifyDBInstance API to change one or more database configuration parameters by specifying these parameters and the new values in the request.
AmazonRDS.modifyDBInstance(ModifyDBInstanceRequest)
Constructor Summary | |
---|---|
ModifyDBInstanceRequest()
Default constructor for a new ModifyDBInstanceRequest object. |
|
ModifyDBInstanceRequest(String dBInstanceIdentifier)
Constructs a new ModifyDBInstanceRequest object. |
Method Summary | |
---|---|
Integer |
getAllocatedStorage()
The new storage capacity of the RDS instance. |
Boolean |
getAllowMajorVersionUpgrade()
The indicates that major version upgrades are allowed. |
Boolean |
getApplyImmediately()
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance. |
Boolean |
getAutoMinorVersionUpgrade()
The indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. |
Integer |
getBackupRetentionPeriod()
The number of days to retain automated backups. |
String |
getDBInstanceClass()
The new compute and memory capacity of the DB Instance. |
String |
getDBInstanceIdentifier()
The DB Instance identifier. |
String |
getDBParameterGroupName()
The name of the DB Parameter Group to apply to this DB Instance. |
List<String> |
getDBSecurityGroups()
A list of DB Security Groups to authorize on this DB Instance. |
String |
getEngineVersion()
The version number of the database engine to upgrade to. |
String |
getMasterUserPassword()
The new password for the DB Instance master user. |
Boolean |
getMultiAZ()
Specifies if the DB Instance is a Multi-AZ deployment. |
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. |
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. |
Boolean |
isAllowMajorVersionUpgrade()
The indicates that major version upgrades are allowed. |
Boolean |
isApplyImmediately()
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance. |
Boolean |
isAutoMinorVersionUpgrade()
The indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. |
Boolean |
isMultiAZ()
Specifies if the DB Instance is a Multi-AZ deployment. |
void |
setAllocatedStorage(Integer allocatedStorage)
The new storage capacity of the RDS instance. |
void |
setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
The indicates that major version upgrades are allowed. |
void |
setApplyImmediately(Boolean applyImmediately)
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
The indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. |
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups. |
void |
setDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB Instance. |
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB Instance identifier. |
void |
setDBParameterGroupName(String dBParameterGroupName)
The name of the DB Parameter Group to apply to this DB Instance. |
void |
setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB Security Groups to authorize on this DB Instance. |
void |
setEngineVersion(String engineVersion)
The version number of the database engine to upgrade to. |
void |
setMasterUserPassword(String masterUserPassword)
The new password for the DB Instance master user. |
void |
setMultiAZ(Boolean multiAZ)
Specifies if the DB Instance is a Multi-AZ deployment. |
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. |
String |
toString()
Returns a string representation of this object; useful for testing and debugging. |
ModifyDBInstanceRequest |
withAllocatedStorage(Integer allocatedStorage)
The new storage capacity of the RDS instance. |
ModifyDBInstanceRequest |
withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
The indicates that major version upgrades are allowed. |
ModifyDBInstanceRequest |
withApplyImmediately(Boolean applyImmediately)
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance. |
ModifyDBInstanceRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
The indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. |
ModifyDBInstanceRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups. |
ModifyDBInstanceRequest |
withDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB Instance. |
ModifyDBInstanceRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB Instance identifier. |
ModifyDBInstanceRequest |
withDBParameterGroupName(String dBParameterGroupName)
The name of the DB Parameter Group to apply to this DB Instance. |
ModifyDBInstanceRequest |
withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB Security Groups to authorize on this DB Instance. |
ModifyDBInstanceRequest |
withDBSecurityGroups(String... dBSecurityGroups)
A list of DB Security Groups to authorize on this DB Instance. |
ModifyDBInstanceRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to upgrade to. |
ModifyDBInstanceRequest |
withMasterUserPassword(String masterUserPassword)
The new password for the DB Instance master user. |
ModifyDBInstanceRequest |
withMultiAZ(Boolean multiAZ)
Specifies if the DB Instance is a Multi-AZ deployment. |
ModifyDBInstanceRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. |
ModifyDBInstanceRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. |
Methods inherited from class com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ModifyDBInstanceRequest()
public ModifyDBInstanceRequest(String dBInstanceIdentifier)
dBInstanceIdentifier
- The DB Instance identifier. This value is
stored as a lowercase string.Method Detail |
---|
public String getDBInstanceIdentifier()
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
dBInstanceIdentifier
- The DB Instance identifier. This value is stored as a lowercase
string.public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier
- The DB Instance identifier. This value is stored as a lowercase
string.
public Integer getAllocatedStorage()
This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.
This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.
public void setAllocatedStorage(Integer allocatedStorage)
This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.
allocatedStorage
- The new storage capacity of the RDS instance. This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.
public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.
Returns a reference to this object so that method calls can be chained together.
allocatedStorage
- The new storage capacity of the RDS instance. This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.
public String getDBInstanceClass()
Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
public void setDBInstanceClass(String dBInstanceClass)
Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
dBInstanceClass
- The new compute and memory capacity of the DB Instance. Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
Returns a reference to this object so that method calls can be chained together.
dBInstanceClass
- The new compute and memory capacity of the DB Instance. Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
public List<String> getDBSecurityGroups()
public void setDBSecurityGroups(Collection<String> dBSecurityGroups)
dBSecurityGroups
- A list of DB Security Groups to authorize on this DB Instance. This
change is asynchronously applied as soon as possible.public ModifyDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- A list of DB Security Groups to authorize on this DB Instance. This
change is asynchronously applied as soon as possible.
public ModifyDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- A list of DB Security Groups to authorize on this DB Instance. This
change is asynchronously applied as soon as possible.
public Boolean isApplyImmediately()
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
public void setApplyImmediately(Boolean applyImmediately)
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
applyImmediately
- Specifies whether or not the modifications in this request and any
pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the DB
Instance. If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately)
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
Returns a reference to this object so that method calls can be chained together.
applyImmediately
- Specifies whether or not the modifications in this request and any
pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the DB
Instance. If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
public Boolean getApplyImmediately()
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.
public String getMasterUserPassword()
public void setMasterUserPassword(String masterUserPassword)
masterUserPassword
- The new password for the DB Instance master user. This change is
asynchronously applied as soon as possible. Between the time of the
request and the completion of the request, the
MasterUserPassword element exists in the
PendingModifiedValues element of the operation response.public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword)
Returns a reference to this object so that method calls can be chained together.
masterUserPassword
- The new password for the DB Instance master user. This change is
asynchronously applied as soon as possible. Between the time of the
request and the completion of the request, the
MasterUserPassword element exists in the
PendingModifiedValues element of the operation response.
public String getDBParameterGroupName()
public void setDBParameterGroupName(String dBParameterGroupName)
dBParameterGroupName
- The name of the DB Parameter Group to apply to this DB Instance. This
change is asynchronously applied as soon as possible for parameters
when the ApplyImmediately parameter is specified as true
for this request.public ModifyDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
dBParameterGroupName
- The name of the DB Parameter Group to apply to this DB Instance. This
change is asynchronously applied as soon as possible for parameters
when the ApplyImmediately parameter is specified as true
for this request.
public Integer getBackupRetentionPeriod()
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
backupRetentionPeriod
- The number of days to retain automated backups. Setting this parameter
to a positive number enables backups. Setting this parameter to 0
disables automated backups.public ModifyDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
Returns a reference to this object so that method calls can be chained together.
backupRetentionPeriod
- The number of days to retain automated backups. Setting this parameter
to a positive number enables backups. Setting this parameter to 0
disables automated backups.
public String getPreferredBackupWindow()
public void setPreferredBackupWindow(String preferredBackupWindow)
preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod.public ModifyDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)
Returns a reference to this object so that method calls can be chained together.
preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod.
public String getPreferredMaintenanceWindow()
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur, which may result in an outage. This change is made immediately.
If moving this window to the current time, there must be at least 120
minutes between the current time and end of the window to ensure
pending changes are applied.public ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur, which may result in an outage. This change is made immediately.
If moving this window to the current time, there must be at least 120
minutes between the current time and end of the window to ensure
pending changes are applied.
public Boolean isMultiAZ()
public void setMultiAZ(Boolean multiAZ)
multiAZ
- Specifies if the DB Instance is a Multi-AZ deployment.public ModifyDBInstanceRequest 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()
For major version upgrades, if a non-default DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
For major version upgrades, if a non-default DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
public void setEngineVersion(String engineVersion)
For major version upgrades, if a non-default DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
engineVersion
- The version number of the database engine to upgrade to. For major version upgrades, if a non-default DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
public ModifyDBInstanceRequest withEngineVersion(String engineVersion)
For major version upgrades, if a non-default DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The version number of the database engine to upgrade to. For major version upgrades, if a non-default DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
public Boolean isAllowMajorVersionUpgrade()
public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
allowMajorVersionUpgrade
- The indicates that major version upgrades are allowed.public ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Returns a reference to this object so that method calls can be chained together.
allowMajorVersionUpgrade
- The indicates that major version upgrades are allowed.
public Boolean getAllowMajorVersionUpgrade()
public Boolean isAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
autoMinorVersionUpgrade
- The indicates that minor version upgrades will be applied
automatically to the DB Instance during the maintenance window.public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- The indicates that minor version upgrades will be applied
automatically to the DB Instance during the maintenance window.
public Boolean getAutoMinorVersionUpgrade()
public String toString()
toString
in class Object
Object.toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |