@Generated(value="software.amazon.awssdk:codegen") public final class ModifyDbInstanceRequest extends NeptuneRequest implements ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ModifyDbInstanceRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
Integer |
allocatedStorage()
Not supported by Neptune.
|
Boolean |
allowMajorVersionUpgrade()
Indicates that major version upgrades are allowed.
|
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. |
Boolean |
autoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
Integer |
backupRetentionPeriod()
Not applicable.
|
static ModifyDbInstanceRequest.Builder |
builder() |
String |
caCertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
|
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.
|
Boolean |
copyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
String |
dbInstanceClass()
The new compute and memory capacity of the DB instance, for example,
db.m4.large. |
String |
dbInstanceIdentifier()
The DB instance identifier.
|
String |
dbParameterGroupName()
The name of the DB parameter group to apply to the DB instance.
|
Integer |
dbPortNumber()
The port number on which the database accepts connections.
|
List<String> |
dbSecurityGroups()
A list of DB security groups to authorize on this DB instance.
|
String |
dbSubnetGroupName()
The new DB subnet group for the DB instance.
|
Boolean |
deletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
domain()
Not supported.
|
String |
domainIAMRoleName()
Not supported
|
Boolean |
enableIAMDatabaseAuthentication()
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
Boolean |
enablePerformanceInsights()
(Not supported by Neptune)
|
String |
engineVersion()
The version number of the database engine to upgrade to.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDbSecurityGroups()
For responses, this returns true if the service returned a value for the DBSecurityGroups property.
|
int |
hashCode() |
boolean |
hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
|
Integer |
iops()
The new Provisioned IOPS (I/O operations per second) value for the instance.
|
String |
licenseModel()
Not supported by Neptune.
|
String |
masterUserPassword()
Not supported by Neptune.
|
Integer |
monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
monitoringRoleArn()
The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
multiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
newDBInstanceIdentifier()
The new DB instance identifier for the DB instance when renaming a DB instance.
|
String |
optionGroupName()
(Not supported by Neptune)
|
String |
performanceInsightsKMSKeyId()
(Not supported by Neptune)
|
String |
preferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled.
|
String |
preferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
|
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.
|
Boolean |
publiclyAccessible()
Deprecated.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ModifyDbInstanceRequest.Builder> |
serializableBuilderClass() |
String |
storageType()
Not supported.
|
String |
tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
|
ModifyDbInstanceRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
vpcSecurityGroupIds()
A list of EC2 VPC security groups to authorize on this DB instance.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String dbInstanceIdentifier()
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 final Integer allocatedStorage()
Not supported by Neptune.
public final 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
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 final 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
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 final boolean hasDbSecurityGroups()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDbSecurityGroups() method.
Constraints:
If supplied, must match existing DBSecurityGroups.
public final boolean hasVpcSecurityGroupIds()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.
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 final 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
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 final String masterUserPassword()
Not supported by Neptune.
public final 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.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
public final 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
Default: Uses existing setting
public final 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
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 final 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
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 final 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.
ApplyImmediately parameter is set to true for this request.public final 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.
public final 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.
public final 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.
true during the maintenance window, and a newer minor version is available, and Neptune has
enabled auto patching for that engine version.public final String licenseModel()
Not supported by Neptune.
public final 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
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 final String optionGroupName()
(Not supported by Neptune)
public final 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
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 final String storageType()
Not supported.
public final String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public final String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public final String caCertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
public final String domain()
Not supported.
public final Boolean copyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
public final 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
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 final 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
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 final Boolean publiclyAccessible()
This flag should no longer be used.
public final 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.
arn:aws:iam:123456789012:role/emaccess.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
public final String domainIAMRoleName()
Not supported
public final 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
Default: 1
Valid Values: 0 - 15
public final 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
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 final Boolean enablePerformanceInsights()
(Not supported by Neptune)
public final String performanceInsightsKMSKeyId()
(Not supported by Neptune)
public final 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.
public final 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.
public ModifyDbInstanceRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>toBuilder in class NeptuneRequestpublic static ModifyDbInstanceRequest.Builder builder()
public static Class<? extends ModifyDbInstanceRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.