@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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) |
Integer |
getAllocatedStorage()
Not supported by Neptune.
|
Boolean |
getAllowMajorVersionUpgrade()
Indicates that major version upgrades are allowed.
|
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.
|
Integer |
getBackupRetentionPeriod()
Not applicable.
|
String |
getCACertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
|
CloudwatchLogsExportConfiguration |
getCloudwatchLogsExportConfiguration()
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance or DB cluster.
|
Boolean |
getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
String |
getDBInstanceClass()
The new compute and memory capacity of the DB instance, for example,
db.m4.large . |
String |
getDBInstanceIdentifier()
The DB instance identifier.
|
String |
getDBParameterGroupName()
The name of the DB parameter group to apply to the DB instance.
|
Integer |
getDBPortNumber()
The port number on which the database accepts connections.
|
List<String> |
getDBSecurityGroups()
A list of DB security groups to authorize on this DB instance.
|
String |
getDBSubnetGroupName()
The new DB subnet group for the DB instance.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
getDomain()
Not supported.
|
String |
getDomainIAMRoleName()
Not supported
|
Boolean |
getEnableIAMDatabaseAuthentication()
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
Boolean |
getEnablePerformanceInsights()
(Not supported by Neptune)
|
String |
getEngineVersion()
The version number of the database engine to upgrade to.
|
Integer |
getIops()
The new Provisioned IOPS (I/O operations per second) value for the instance.
|
String |
getLicenseModel()
Not supported by Neptune.
|
String |
getMasterUserPassword()
Not supported by Neptune.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
getNewDBInstanceIdentifier()
The new DB instance identifier for the DB instance when renaming a DB instance.
|
String |
getOptionGroupName()
(Not supported by Neptune)
|
String |
getPerformanceInsightsKMSKeyId()
(Not supported by Neptune)
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled.
|
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 a Read Replica is promoted to the primary instance after a failure of
the existing primary instance.
|
Boolean |
getPubliclyAccessible()
Deprecated.
|
String |
getStorageType()
Not supported.
|
String |
getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
getTdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to authorize on this DB instance.
|
int |
hashCode() |
Boolean |
isAllowMajorVersionUpgrade()
Indicates that major version upgrades are allowed.
|
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.
|
Boolean |
isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
Boolean |
isEnableIAMDatabaseAuthentication()
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
Boolean |
isEnablePerformanceInsights()
(Not supported by Neptune)
|
Boolean |
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
Deprecated.
|
void |
setAllocatedStorage(Integer allocatedStorage)
Not supported by Neptune.
|
void |
setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Indicates that major version upgrades are allowed.
|
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 |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
Not applicable.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
|
void |
setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance or DB cluster.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
void |
setDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance, for example,
db.m4.large . |
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
void |
setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance.
|
void |
setDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
|
void |
setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to authorize on this DB instance.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance.
|
void |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
void |
setDomain(String domain)
Not supported.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
Not supported
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
(Not supported by Neptune)
|
void |
setEngineVersion(String engineVersion)
The version number of the database engine to upgrade to.
|
void |
setIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the instance.
|
void |
setLicenseModel(String licenseModel)
Not supported by Neptune.
|
void |
setMasterUserPassword(String masterUserPassword)
Not supported by Neptune.
|
void |
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
void |
setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
void |
setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance.
|
void |
setOptionGroupName(String optionGroupName)
(Not supported by Neptune)
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
(Not supported by Neptune)
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled.
|
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 a Read Replica is promoted to the primary instance after a failure of
the existing primary instance.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Deprecated.
|
void |
setStorageType(String storageType)
Not supported.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
void |
setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance.
|
String |
toString()
Returns a string representation of this object.
|
ModifyDBInstanceRequest |
withAllocatedStorage(Integer allocatedStorage)
Not supported by Neptune.
|
ModifyDBInstanceRequest |
withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Indicates that major version upgrades are allowed.
|
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 |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
Not applicable.
|
ModifyDBInstanceRequest |
withCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
|
ModifyDBInstanceRequest |
withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance or DB cluster.
|
ModifyDBInstanceRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
ModifyDBInstanceRequest |
withDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance, for example,
db.m4.large . |
ModifyDBInstanceRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
ModifyDBInstanceRequest |
withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance.
|
ModifyDBInstanceRequest |
withDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
|
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 |
withDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance.
|
ModifyDBInstanceRequest |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
ModifyDBInstanceRequest |
withDomain(String domain)
Not supported.
|
ModifyDBInstanceRequest |
withDomainIAMRoleName(String domainIAMRoleName)
Not supported
|
ModifyDBInstanceRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
ModifyDBInstanceRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
(Not supported by Neptune)
|
ModifyDBInstanceRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to upgrade to.
|
ModifyDBInstanceRequest |
withIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the instance.
|
ModifyDBInstanceRequest |
withLicenseModel(String licenseModel)
Not supported by Neptune.
|
ModifyDBInstanceRequest |
withMasterUserPassword(String masterUserPassword)
Not supported by Neptune.
|
ModifyDBInstanceRequest |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
ModifyDBInstanceRequest |
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
ModifyDBInstanceRequest |
withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
ModifyDBInstanceRequest |
withNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance.
|
ModifyDBInstanceRequest |
withOptionGroupName(String optionGroupName)
(Not supported by Neptune)
|
ModifyDBInstanceRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
(Not supported by Neptune)
|
ModifyDBInstanceRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled.
|
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 a Read Replica is promoted to the primary instance after a failure of
the existing primary instance.
|
ModifyDBInstanceRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Deprecated.
|
ModifyDBInstanceRequest |
withStorageType(String storageType)
Not supported.
|
ModifyDBInstanceRequest |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
ModifyDBInstanceRequest |
withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
ModifyDBInstanceRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance.
|
ModifyDBInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB 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 setAllocatedStorage(Integer allocatedStorage)
Not supported by Neptune.
allocatedStorage
- Not supported by Neptune.public Integer getAllocatedStorage()
Not supported by Neptune.
public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
Not supported by Neptune.
allocatedStorage
- Not supported by Neptune.public void setDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all Amazon 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.m4.large
. Not all DB
instance classes are available in all Amazon 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.m4.large
. Not all DB
instance classes are available in all Amazon 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.m4.large
. Not all DB
instance classes are available in all Amazon 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.m4.large
. Not all DB
instance classes are available in all Amazon 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.m4.large
. Not all DB
instance classes are available in all Amazon 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 setDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
dBSubnetGroupName
- The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a
different VPC.
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
public String getDBSubnetGroupName()
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
public ModifyDBInstanceRequest withDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
dBSubnetGroupName
- The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a
different VPC.
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
public List<String> getDBSecurityGroups()
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
Constraints:
If supplied, must match existing DBSecurityGroups.
public void setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
dBSecurityGroups
- A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an
outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
public ModifyDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
NOTE: This method appends the values to the existing list (if any). Use
setDBSecurityGroups(java.util.Collection)
or withDBSecurityGroups(java.util.Collection)
if you
want to override the existing values.
dBSecurityGroups
- A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an
outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
public ModifyDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
dBSecurityGroups
- A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an
outage and the change is asynchronously applied as soon as possible.
Constraints:
If supplied, must match existing DBSecurityGroups.
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied
as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
public ModifyDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied
as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
public ModifyDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied
as soon as possible.
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
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 call to
RebootDBInstance, or the next failure 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 call to
RebootDBInstance, or the next failure 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 call to
RebootDBInstance, or the next failure 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 call to
RebootDBInstance, or the next failure 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 call to
RebootDBInstance, or the next failure 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 call to
RebootDBInstance, or the next failure 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 call to
RebootDBInstance, or the next failure 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 call to
RebootDBInstance, or the next failure reboot.
Default: false
public void setMasterUserPassword(String masterUserPassword)
Not supported by Neptune.
masterUserPassword
- Not supported by Neptune.public String getMasterUserPassword()
Not supported by Neptune.
public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword)
Not supported by Neptune.
masterUserPassword
- Not supported by Neptune.public void setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
dBParameterGroupName
- The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an
outage. The parameter group name itself is changed immediately, but the actual parameter changes are not
applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically
and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
public String getDBParameterGroupName()
The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
public ModifyDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
dBParameterGroupName
- The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an
outage. The parameter group name itself is changed immediately, but the actual parameter changes are not
applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically
and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
backupRetentionPeriod
- Not applicable. The retention period for automated backups is managed by the DB cluster. For more
information, see ModifyDBCluster.
Default: Uses existing setting
public Integer getBackupRetentionPeriod()
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Default: Uses existing setting
public ModifyDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
backupRetentionPeriod
- Not applicable. The retention period for automated backups is managed by the DB cluster. For more
information, see ModifyDBCluster.
Default: Uses existing setting
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
public ModifyDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled.
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
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, then changing this parameter will cause a reboot of the DB instance. If 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 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, then changing this parameter will cause a
reboot of the DB instance. If 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 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, then changing this parameter will cause a reboot of the DB instance. If 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 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, then changing this parameter will cause a reboot of the DB instance. If 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 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, then changing this parameter will cause a
reboot of the DB instance. If 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 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 setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and
the change is applied during the next maintenance window unless the ApplyImmediately
parameter is
set to true
for this request.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage
and the change is applied during the next maintenance window unless the ApplyImmediately
parameter is set to true
for this request.public Boolean getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and
the change is applied during the next maintenance window unless the ApplyImmediately
parameter is
set to true
for this request.
ApplyImmediately
parameter is set to true
for this request.public ModifyDBInstanceRequest withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and
the change is applied during the next maintenance window unless the ApplyImmediately
parameter is
set to true
for this request.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage
and the change is applied during the next maintenance window unless the ApplyImmediately
parameter is set to true
for this request.public Boolean isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and
the change is applied during the next maintenance window unless the ApplyImmediately
parameter is
set to true
for this request.
ApplyImmediately
parameter is set to true
for this request.public void setEngineVersion(String engineVersion)
The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
engineVersion
- The version number of the database engine to upgrade to. Currently, setting this parameter has no effect.
To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction
API.public String getEngineVersion()
The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
public ModifyDBInstanceRequest withEngineVersion(String engineVersion)
The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
engineVersion
- The version number of the database engine to upgrade to. Currently, setting this parameter has no effect.
To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction
API.public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
allowMajorVersionUpgrade
- Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and
the change is asynchronously applied as soon as possible.public Boolean getAllowMajorVersionUpgrade()
Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
public ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
allowMajorVersionUpgrade
- Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and
the change is asynchronously applied as soon as possible.public Boolean isAllowMajorVersionUpgrade()
Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
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 will result if this parameter is set to true
during the
maintenance window, and a newer minor version is available, and Neptune has enabled auto 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 will result if this parameter is set to
true
during the maintenance window, and a newer minor version is available, and Neptune has
enabled auto 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 will result if this parameter is set to true
during the
maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine
version.
true
during the maintenance window, and a newer minor version is available, and Neptune has
enabled auto 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 will result if this parameter is set to true
during the
maintenance window, and a newer minor version is available, and Neptune has enabled auto 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 will result if this parameter is set to
true
during the maintenance window, and a newer minor version is available, and Neptune has
enabled auto 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 will result if this parameter is set to true
during the
maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine
version.
true
during the maintenance window, and a newer minor version is available, and Neptune has
enabled auto patching for that engine version.public void setLicenseModel(String licenseModel)
Not supported by Neptune.
licenseModel
- Not supported by Neptune.public String getLicenseModel()
Not supported by Neptune.
public ModifyDBInstanceRequest withLicenseModel(String licenseModel)
Not supported by Neptune.
licenseModel
- Not supported by Neptune.public void setIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately
parameter is set to true
for this request.
Default: Uses existing setting
iops
- The new Provisioned IOPS (I/O operations per second) value for the instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is set to true
for this request.
Default: Uses existing setting
public Integer getIops()
The new Provisioned IOPS (I/O operations per second) value for the instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately
parameter is set to true
for this request.
Default: Uses existing setting
Changing this setting doesn't result in an outage and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is set to true
for this request.
Default: Uses existing setting
public ModifyDBInstanceRequest withIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately
parameter is set to true
for this request.
Default: Uses existing setting
iops
- The new Provisioned IOPS (I/O operations per second) value for the instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is set to true
for this request.
Default: Uses existing setting
public void setOptionGroupName(String optionGroupName)
(Not supported by Neptune)
optionGroupName
- (Not supported by Neptune)public String getOptionGroupName()
(Not supported by Neptune)
public ModifyDBInstanceRequest withOptionGroupName(String optionGroupName)
(Not supported by Neptune)
optionGroupName
- (Not supported by Neptune)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 will occur immediately if you set Apply Immediately
to true, or will
occur during the next maintenance window if 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 will occur immediately if you set Apply Immediately
to true, or will occur during the next maintenance window if 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 will occur immediately if you set Apply Immediately
to true, or will
occur during the next maintenance window if 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, or will occur during the next maintenance window if 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 will occur immediately if you set Apply Immediately
to true, or will
occur during the next maintenance window if 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 will occur immediately if you set Apply Immediately
to true, or will occur during the next maintenance window if 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 setStorageType(String storageType)
Not supported.
storageType
- Not supported.public String getStorageType()
Not supported.
public ModifyDBInstanceRequest withStorageType(String storageType)
Not supported.
storageType
- Not supported.public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.public String getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public ModifyDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.public String getTdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public ModifyDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.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 setDomain(String domain)
Not supported.
domain
- Not supported.public String getDomain()
Not supported.
public ModifyDBInstanceRequest withDomain(String domain)
Not supported.
domain
- Not supported.public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The
default is false.public Boolean getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
public ModifyDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The
default is false.public Boolean isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public ModifyDBInstanceRequest withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public void setDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any of the port values specified for options
in the option group for the DB instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of the
ApplyImmediately
parameter.
Default: 8182
dBPortNumber
- The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any of the port values specified for
options in the option group for the DB instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of
the ApplyImmediately
parameter.
Default: 8182
public Integer getDBPortNumber()
The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any of the port values specified for options
in the option group for the DB instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of the
ApplyImmediately
parameter.
Default: 8182
The value of the DBPortNumber
parameter must not match any of the port values specified for
options in the option group for the DB instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of
the ApplyImmediately
parameter.
Default: 8182
public ModifyDBInstanceRequest withDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any of the port values specified for options
in the option group for the DB instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of the
ApplyImmediately
parameter.
Default: 8182
dBPortNumber
- The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any of the port values specified for
options in the option group for the DB instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of
the ApplyImmediately
parameter.
Default: 8182
@Deprecated public void setPubliclyAccessible(Boolean publiclyAccessible)
This flag should no longer be used.
publiclyAccessible
- This flag should no longer be used.@Deprecated public Boolean getPubliclyAccessible()
This flag should no longer be used.
@Deprecated public ModifyDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
This flag should no longer be used.
publiclyAccessible
- This flag should no longer be used.@Deprecated public Boolean isPubliclyAccessible()
This flag should no longer be used.
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch
Logs. For example, arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public String getMonitoringRoleArn()
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public ModifyDBInstanceRequest withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch
Logs. For example, arn:aws:iam:123456789012:role/emaccess
.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public void setDomainIAMRoleName(String domainIAMRoleName)
Not supported
domainIAMRoleName
- Not supportedpublic String getDomainIAMRoleName()
Not supported
public ModifyDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)
Not supported
domainIAMRoleName
- Not supportedpublic void setPromotionTier(Integer promotionTier)
A value that specifies the order in which a Read 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 a Read 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 a Read 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 a Read 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 a Read Replica is promoted to the primary instance after a
failure of the existing primary instance.
Default: 1
Valid Values: 0 - 15
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
public ModifyDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
You can enable IAM database authentication for the following database engines
Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: false
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
(Not supported by Neptune)
enablePerformanceInsights
- (Not supported by Neptune)public Boolean getEnablePerformanceInsights()
(Not supported by Neptune)
public ModifyDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
(Not supported by Neptune)
enablePerformanceInsights
- (Not supported by Neptune)public Boolean isEnablePerformanceInsights()
(Not supported by Neptune)
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
(Not supported by Neptune)
performanceInsightsKMSKeyId
- (Not supported by Neptune)public String getPerformanceInsightsKMSKeyId()
(Not supported by Neptune)
public ModifyDBInstanceRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
(Not supported by Neptune)
performanceInsightsKMSKeyId
- (Not supported by Neptune)public void setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance or DB cluster.public CloudwatchLogsExportConfiguration getCloudwatchLogsExportConfiguration()
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
public ModifyDBInstanceRequest withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance or DB cluster.public void setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting
a DB Instance.public Boolean getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
public ModifyDBInstanceRequest withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting
a DB Instance.public Boolean isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
public String toString()
toString
in class Object
Object.toString()
public ModifyDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()