@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input to ModifyDBInstance.
NOOP
Constructor and Description |
---|
ModifyDBInstanceRequest() |
Modifier and Type | Method and Description |
---|---|
ModifyDBInstanceRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getApplyImmediately()
Specifies whether 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()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
String |
getCACertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
|
String |
getDBInstanceClass()
The new compute and memory capacity of the DB instance; for example,
db.r5.large . |
String |
getDBInstanceIdentifier()
The DB instance identifier.
|
String |
getNewDBInstanceIdentifier()
The new DB instance identifier for the DB instance when renaming a DB instance.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
|
Integer |
getPromotionTier()
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after
a failure of the existing primary instance.
|
int |
hashCode() |
Boolean |
isApplyImmediately()
Specifies whether 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()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
void |
setApplyImmediately(Boolean applyImmediately)
Specifies whether 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)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
|
void |
setDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance; for example,
db.r5.large . |
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
void |
setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
|
void |
setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after
a failure of the existing primary instance.
|
String |
toString()
Returns a string representation of this object.
|
ModifyDBInstanceRequest |
withApplyImmediately(Boolean applyImmediately)
Specifies whether 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)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
ModifyDBInstanceRequest |
withCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
|
ModifyDBInstanceRequest |
withDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance; for example,
db.r5.large . |
ModifyDBInstanceRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
ModifyDBInstanceRequest |
withNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance.
|
ModifyDBInstanceRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
|
ModifyDBInstanceRequest |
withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after
a failure of the existing primary instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance
.
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance
.
public String getDBInstanceIdentifier()
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance
.
Constraints:
Must match the identifier of an existing DBInstance
.
public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance
.
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance
.
public void setDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance; for example, db.r5.large
. Not all DB
instance classes are available in all AWS Regions.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting.
dBInstanceClass
- The new compute and memory capacity of the DB instance; for example, db.r5.large
. Not all DB
instance classes are available in all AWS Regions.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless ApplyImmediately
is specified as true
for this
request.
Default: Uses existing setting.
public String getDBInstanceClass()
The new compute and memory capacity of the DB instance; for example, db.r5.large
. Not all DB
instance classes are available in all AWS Regions.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting.
db.r5.large
. Not all DB
instance classes are available in all AWS Regions.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless ApplyImmediately
is specified as true
for this
request.
Default: Uses existing setting.
public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance; for example, db.r5.large
. Not all DB
instance classes are available in all AWS Regions.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting.
dBInstanceClass
- The new compute and memory capacity of the DB instance; for example, db.r5.large
. Not all DB
instance classes are available in all AWS Regions.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless ApplyImmediately
is specified as true
for this
request.
Default: Uses existing setting.
public void setApplyImmediately(Boolean applyImmediately)
Specifies whether 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 set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
applyImmediately
- Specifies whether 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 set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
public Boolean getApplyImmediately()
Specifies whether 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 set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately)
Specifies whether 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 set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
applyImmediately
- Specifies whether 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 set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
public Boolean isApplyImmediately()
Specifies whether 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 set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB instance are applied during the next
maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the DB instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
Changing this parameter doesn't result in an outage except in the following situation, and the change is
asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the
maintenance window is changed to include the current time, changing this parameter causes a reboot of the
DB instance. If you are moving this window to the current time, there must be at least 30 minutes between
the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
public String getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the DB instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
public ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the DB instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
Changing this parameter doesn't result in an outage except in the following situation, and the change is
asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the
maintenance window is changed to include the current time, changing this parameter causes a reboot of the
DB instance. If you are moving this window to the current time, there must be at least 30 minutes between
the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
Changing this parameter doesn't result in an outage except in the following case, and the change is
asynchronously applied as soon as possible. An outage results if this parameter is set to true
during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled
automatic patching for that engine version.
autoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance
window. Changing this parameter doesn't result in an outage except in the following case, and the change
is asynchronously applied as soon as possible. An outage results if this parameter is set to
true
during the maintenance window, and a newer minor version is available, and Amazon
DocumentDB has enabled automatic patching for that engine version.public Boolean getAutoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
Changing this parameter doesn't result in an outage except in the following case, and the change is
asynchronously applied as soon as possible. An outage results if this parameter is set to true
during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled
automatic patching for that engine version.
true
during the maintenance window, and a newer minor version is available, and Amazon
DocumentDB has enabled automatic patching for that engine version.public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
Changing this parameter doesn't result in an outage except in the following case, and the change is
asynchronously applied as soon as possible. An outage results if this parameter is set to true
during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled
automatic patching for that engine version.
autoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance
window. Changing this parameter doesn't result in an outage except in the following case, and the change
is asynchronously applied as soon as possible. An outage results if this parameter is set to
true
during the maintenance window, and a newer minor version is available, and Amazon
DocumentDB has enabled automatic patching for that engine version.public Boolean isAutoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
Changing this parameter doesn't result in an outage except in the following case, and the change is
asynchronously applied as soon as possible. An outage results if this parameter is set to true
during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled
automatic patching for that engine version.
true
during the maintenance window, and a newer minor version is available, and Amazon
DocumentDB has enabled automatic patching for that engine version.public void setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance
identifier, an instance reboot occurs immediately if you set Apply Immediately
to true
.
It occurs during the next maintenance window if you set Apply Immediately
to false
.
This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
newDBInstanceIdentifier
- The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB
instance identifier, an instance reboot occurs immediately if you set Apply Immediately
to
true
. It occurs during the next maintenance window if you set Apply Immediately
to false
. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public String getNewDBInstanceIdentifier()
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance
identifier, an instance reboot occurs immediately if you set Apply Immediately
to true
.
It occurs during the next maintenance window if you set Apply Immediately
to false
.
This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Apply Immediately
to
true
. It occurs during the next maintenance window if you set Apply Immediately
to false
. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public ModifyDBInstanceRequest withNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance
identifier, an instance reboot occurs immediately if you set Apply Immediately
to true
.
It occurs during the next maintenance window if you set Apply Immediately
to false
.
This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
newDBInstanceIdentifier
- The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB
instance identifier, an instance reboot occurs immediately if you set Apply Immediately
to
true
. It occurs during the next maintenance window if you set Apply Immediately
to false
. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public void setCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
cACertificateIdentifier
- Indicates the certificate that needs to be associated with the instance.public String getCACertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
public ModifyDBInstanceRequest withCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
cACertificateIdentifier
- Indicates the certificate that needs to be associated with the instance.public void setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
promotionTier
- A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance
after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
public Integer getPromotionTier()
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
Default: 1
Valid values: 0-15
public ModifyDBInstanceRequest withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
promotionTier
- A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance
after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
public String toString()
toString
in class Object
Object.toString()
public ModifyDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.