Class ModifyDbInstanceRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.neptune.model.NeptuneRequest
-
- software.amazon.awssdk.services.neptune.model.ModifyDbInstanceRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyDbInstanceRequest extends NeptuneRequest implements ToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceModifyDbInstanceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IntegerallocatedStorage()Not supported by Neptune.BooleanallowMajorVersionUpgrade()Indicates that major version upgrades are allowed.BooleanapplyImmediately()Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of thePreferredMaintenanceWindowsetting for the DB instance.BooleanautoMinorVersionUpgrade()Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.IntegerbackupRetentionPeriod()Not applicable.static ModifyDbInstanceRequest.Builderbuilder()StringcaCertificateIdentifier()Indicates the certificate that needs to be associated with the instance.CloudwatchLogsExportConfigurationcloudwatchLogsExportConfiguration()The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.BooleancopyTagsToSnapshot()True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.StringdbInstanceClass()The new compute and memory capacity of the DB instance, for example,db.m4.large.StringdbInstanceIdentifier()The DB instance identifier.StringdbParameterGroupName()The name of the DB parameter group to apply to the DB instance.IntegerdbPortNumber()The port number on which the database accepts connections.List<String>dbSecurityGroups()A list of DB security groups to authorize on this DB instance.StringdbSubnetGroupName()The new DB subnet group for the DB instance.BooleandeletionProtection()A value that indicates whether the DB instance has deletion protection enabled.Stringdomain()Not supported.StringdomainIAMRoleName()Not supportedBooleanenableIAMDatabaseAuthentication()True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.BooleanenablePerformanceInsights()(Not supported by Neptune)StringengineVersion()The version number of the database engine to upgrade to.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDbSecurityGroups()For responses, this returns true if the service returned a value for the DBSecurityGroups property.inthashCode()booleanhasVpcSecurityGroupIds()For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.Integeriops()The new Provisioned IOPS (I/O operations per second) value for the instance.StringlicenseModel()Not supported by Neptune.StringmasterUserPassword()Not supported by Neptune.IntegermonitoringInterval()The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.StringmonitoringRoleArn()The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs.BooleanmultiAZ()Specifies if the DB instance is a Multi-AZ deployment.StringnewDBInstanceIdentifier()The new DB instance identifier for the DB instance when renaming a DB instance.StringoptionGroupName()(Not supported by Neptune)StringperformanceInsightsKMSKeyId()(Not supported by Neptune)StringpreferredBackupWindow()The daily time range during which automated backups are created if automated backups are enabled.StringpreferredMaintenanceWindow()The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.IntegerpromotionTier()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.BooleanpubliclyAccessible()Deprecated.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ModifyDbInstanceRequest.Builder>serializableBuilderClass()StringstorageType()Not supported.StringtdeCredentialArn()The ARN from the key store with which to associate the instance for TDE encryption.StringtdeCredentialPassword()The password for the given ARN from the key store in order to access the device.ModifyDbInstanceRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<String>vpcSecurityGroupIds()A list of EC2 VPC security groups to authorize on this DB instance.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dbInstanceIdentifier
public final String dbInstanceIdentifier()
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBInstance.
- Returns:
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBInstance.
-
-
-
allocatedStorage
public final Integer allocatedStorage()
Not supported by Neptune.
- Returns:
- Not supported by Neptune.
-
dbInstanceClass
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
ApplyImmediatelyis specified astruefor this request.Default: Uses existing setting
- Returns:
- 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
ApplyImmediatelyis specified astruefor this request.Default: Uses existing setting
-
dbSubnetGroupName
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
truefor theApplyImmediatelyparameter.Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mySubnetGroup- Returns:
- 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
truefor theApplyImmediatelyparameter.Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mySubnetGroup
-
hasDbSecurityGroups
public final boolean hasDbSecurityGroups()
For responses, this returns true if the service returned a value for the DBSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
dbSecurityGroups
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.- Returns:
- 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.
-
-
-
hasVpcSecurityGroupIds
public final boolean hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
vpcSecurityGroupIds
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.- Returns:
- 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.
-
-
-
applyImmediately
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
PreferredMaintenanceWindowsetting 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- Returns:
- Specifies whether the modifications in this request and any pending modifications are asynchronously
applied as soon as possible, regardless of the
PreferredMaintenanceWindowsetting 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
-
masterUserPassword
public final String masterUserPassword()
Not supported by Neptune.
- Returns:
- Not supported by Neptune.
-
dbParameterGroupName
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.
- Returns:
- 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.
-
backupRetentionPeriod
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
- Returns:
- Not applicable. The retention period for automated backups is managed by the DB cluster. For more
information, see ModifyDBCluster.
Default: Uses existing setting
-
preferredBackupWindow
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
- Returns:
- 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
-
-
-
preferredMaintenanceWindow
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
- Returns:
- 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
-
multiAZ
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
ApplyImmediatelyparameter is set totruefor this request.- Returns:
- 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
ApplyImmediatelyparameter is set totruefor this request.
-
engineVersion
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.
- Returns:
- 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.
-
allowMajorVersionUpgrade
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.
- Returns:
- 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.
-
autoMinorVersionUpgrade
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
trueduring the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.- Returns:
- 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
trueduring the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.
-
licenseModel
public final String licenseModel()
Not supported by Neptune.
- Returns:
- Not supported by Neptune.
-
iops
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
ApplyImmediatelyparameter is set totruefor this request.Default: Uses existing setting
- Returns:
- 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
ApplyImmediatelyparameter is set totruefor this request.Default: Uses existing setting
-
optionGroupName
public final String optionGroupName()
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
newDBInstanceIdentifier
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 Immediatelyto true, or will occur during the next maintenance window ifApply Immediatelyto 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- Returns:
- 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 Immediatelyto true, or will occur during the next maintenance window ifApply Immediatelyto 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 -
-
-
storageType
public final String storageType()
Not supported.
- Returns:
- Not supported.
-
tdeCredentialArn
public final String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
- Returns:
- The ARN from the key store with which to associate the instance for TDE encryption.
-
tdeCredentialPassword
public final String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
- Returns:
- The password for the given ARN from the key store in order to access the device.
-
caCertificateIdentifier
public final String caCertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
- Returns:
- Indicates the certificate that needs to be associated with the instance.
-
domain
public final String domain()
Not supported.
- Returns:
- Not supported.
-
copyTagsToSnapshot
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.
- Returns:
- True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
-
monitoringInterval
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
MonitoringRoleArnis specified, then you must also setMonitoringIntervalto a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60- Returns:
- 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
MonitoringRoleArnis specified, then you must also setMonitoringIntervalto a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
-
dbPortNumber
public final Integer dbPortNumber()
The port number on which the database accepts connections.
The value of the
DBPortNumberparameter 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
DBPortNumbervalue regardless of the value of theApplyImmediatelyparameter.Default:
8182- Returns:
- The port number on which the database accepts connections.
The value of the
DBPortNumberparameter 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
DBPortNumbervalue regardless of the value of theApplyImmediatelyparameter.Default:
8182
-
publiclyAccessible
@Deprecated public final Boolean publiclyAccessible()
Deprecated.This flag should no longer be used.
- Returns:
- This flag should no longer be used.
-
monitoringRoleArn
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
MonitoringIntervalis set to a value other than 0, then you must supply aMonitoringRoleArnvalue.- Returns:
- 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
MonitoringIntervalis set to a value other than 0, then you must supply aMonitoringRoleArnvalue.
-
domainIAMRoleName
public final String domainIAMRoleName()
Not supported
- Returns:
- Not supported
-
promotionTier
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
- Returns:
- 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
-
enableIAMDatabaseAuthentication
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- Returns:
- 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
-
enablePerformanceInsights
public final Boolean enablePerformanceInsights()
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
performanceInsightsKMSKeyId
public final String performanceInsightsKMSKeyId()
(Not supported by Neptune)
- Returns:
- (Not supported by Neptune)
-
cloudwatchLogsExportConfiguration
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.
- Returns:
- The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
-
deletionProtection
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.
- Returns:
- 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.
-
toBuilder
public ModifyDbInstanceRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModifyDbInstanceRequest.Builder,ModifyDbInstanceRequest>- Specified by:
toBuilderin classNeptuneRequest
-
builder
public static ModifyDbInstanceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyDbInstanceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-