/AWS1/CL_NEP=>MODIFYDBINSTANCE()
¶
About ModifyDBInstance¶
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DBINSTANCEIDENTIFIER
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Optional arguments:¶
IV_ALLOCATEDSTORAGE
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
Not supported by Neptune.
IV_DBINSTANCECLASS
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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 astrue
for this request.Default: Uses existing setting
IV_DBSUBNETGROUPNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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 theApplyImmediately
parameter.Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mySubnetGroup
IT_DBSECURITYGROUPS
TYPE /AWS1/CL_NEPDBSECGRPNAMELIST_W=>TT_DBSECURITYGROUPNAMELIST
TT_DBSECURITYGROUPNAMELIST
¶
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.
IT_VPCSECURITYGROUPIDS
TYPE /AWS1/CL_NEPVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST
TT_VPCSECURITYGROUPIDLIST
¶
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.
IV_APPLYIMMEDIATELY
TYPE /AWS1/NEPBOOLEAN
/AWS1/NEPBOOLEAN
¶
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
IV_MASTERUSERPASSWORD
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported by Neptune.
IV_DBPARAMETERGROUPNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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.
IV_BACKUPRETENTIONPERIOD
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
IV_PREFERREDBACKUPWINDOW
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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
IV_PREFERREDMAINTENANCEWIN00
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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
IV_MULTIAZ
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
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 totrue
for this request.
IV_ENGINEVERSION
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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.
IV_ALLOWMAJORVERSIONUPGRADE
TYPE /AWS1/NEPBOOLEAN
/AWS1/NEPBOOLEAN
¶
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.
IV_AUTOMINORVERSIONUPGRADE
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
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.
IV_LICENSEMODEL
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported by Neptune.
IV_IOPS
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
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 totrue
for this request.Default: Uses existing setting
IV_OPTIONGROUPNAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
(Not supported by Neptune)
IV_NEWDBINSTANCEIDENTIFIER
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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 ifApply 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
IV_STORAGETYPE
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported.
IV_TDECREDENTIALARN
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The ARN from the key store with which to associate the instance for TDE encryption.
IV_TDECREDENTIALPASSWORD
TYPE /AWS1/NEPSENSITIVESTRING
/AWS1/NEPSENSITIVESTRING
¶
The password for the given ARN from the key store in order to access the device.
IV_CACERTIFICATEIDENTIFIER
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Indicates the certificate that needs to be associated with the instance.
IV_DOMAIN
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported.
IV_COPYTAGSTOSNAPSHOT
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
IV_MONITORINGINTERVAL
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
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 setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
IV_DBPORTNUMBER
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
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 theApplyImmediately
parameter.Default:
8182
IV_PUBLICLYACCESSIBLE
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
This flag should no longer be used.
IV_MONITORINGROLEARN
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
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 aMonitoringRoleArn
value.
IV_DOMAINIAMROLENAME
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
Not supported
IV_PROMOTIONTIER
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
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
IV_ENBIAMDATABASEAUTHNTCTN
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
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
IV_ENABLEPERFORMANCEINSIGHTS
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
(Not supported by Neptune)
IV_PERFORMANCEINSIGHTSKMSK00
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
(Not supported by Neptune)
IO_CLOUDWATCHLOGSEXPORTCONF
TYPE REF TO /AWS1/CL_NEPCLOUDWATCHLOGSEX00
/AWS1/CL_NEPCLOUDWATCHLOGSEX00
¶
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
IV_DELETIONPROTECTION
TYPE /AWS1/NEPBOOLEANOPTIONAL
/AWS1/NEPBOOLEANOPTIONAL
¶
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.