Neptune.Client.modify_db_instance(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_instance(
DBInstanceIdentifier='string',
AllocatedStorage=123,
DBInstanceClass='string',
DBSubnetGroupName='string',
DBSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
ApplyImmediately=True|False,
MasterUserPassword='string',
DBParameterGroupName='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
Iops=123,
OptionGroupName='string',
NewDBInstanceIdentifier='string',
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
CACertificateIdentifier='string',
Domain='string',
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
DBPortNumber=123,
PubliclyAccessible=True|False,
MonitoringRoleArn='string',
DomainIAMRoleName='string',
PromotionTier=123,
EnableIAMDatabaseAuthentication=True|False,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
CloudwatchLogsExportConfiguration={
'EnableLogTypes': [
'string',
],
'DisableLogTypes': [
'string',
]
},
DeletionProtection=True|False
)
[REQUIRED]
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
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
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
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:
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:
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
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.
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
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:
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
ApplyImmediately parameter is set to true for this request.true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.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
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:
Example: mydbinstance
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
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 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.
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
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
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The list of log types to enable.
The list of log types to disable.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon Neptune DB instance.
This data type is used as a response element in the DescribeDBInstances action.
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
MasterUsername (string) --
Not supported by Neptune.
DBName (string) --
The database name.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
Not supported by Neptune.
InstanceCreateTime (datetime) --
Provides the date and time the DB instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
DBSecurityGroups (list) --
Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
Specifies membership in a designated DB security group.
DBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
DBParameterGroupName (string) --
The name of the DP parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
Specifies a subnet.
This data type is used as a response element in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the EC2 Availability Zone that the subnet is in.
Name (string) --
The name of the availability zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Not supported by Neptune.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
Not supported by Neptune.
Iops (integer) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
LicenseModel (string) --
License model information for this DB instance.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
(Not supported by Neptune)
(dict) --
Not supported by Neptune.
OptionGroupName (string) --
Not supported by Neptune.
Status (string) --
Not supported by Neptune.
CharacterSetName (string) --
(Not supported by Neptune)
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
This flag should no longer be used.
StatusInfos (list) --
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Not supported: The encryption for DB instances is managed by the DB cluster.
KmsKeyId (string) --
Not supported: The encryption for DB instances is managed by the DB cluster.
DbiResourceId (string) --
The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
Not supported
(dict) --
An Active Directory Domain membership record associated with a DB instance.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
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.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
Not supported.
IAMDatabaseAuthenticationEnabled (boolean) --
True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.
PerformanceInsightsEnabled (boolean) --
(Not supported by Neptune)
PerformanceInsightsKMSKeyId (string) --
(Not supported by Neptune)
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
DeletionProtection (boolean) --
Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.
Exceptions
Neptune.Client.exceptions.InvalidDBInstanceStateFaultNeptune.Client.exceptions.InvalidDBSecurityGroupStateFaultNeptune.Client.exceptions.DBInstanceAlreadyExistsFaultNeptune.Client.exceptions.DBInstanceNotFoundFaultNeptune.Client.exceptions.DBSecurityGroupNotFoundFaultNeptune.Client.exceptions.DBParameterGroupNotFoundFaultNeptune.Client.exceptions.InsufficientDBInstanceCapacityFaultNeptune.Client.exceptions.StorageQuotaExceededFaultNeptune.Client.exceptions.InvalidVPCNetworkStateFaultNeptune.Client.exceptions.ProvisionedIopsNotAvailableInAZFaultNeptune.Client.exceptions.OptionGroupNotFoundFaultNeptune.Client.exceptions.DBUpgradeDependencyFailureFaultNeptune.Client.exceptions.StorageTypeNotSupportedFaultNeptune.Client.exceptions.AuthorizationNotFoundFaultNeptune.Client.exceptions.CertificateNotFoundFaultNeptune.Client.exceptions.DomainNotFoundFault