Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Modify 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.
- modifyDBInstance :: Text -> ModifyDBInstance
- data ModifyDBInstance
- mdiEngineVersion :: Lens' ModifyDBInstance (Maybe Text)
- mdiDBSecurityGroups :: Lens' ModifyDBInstance [Text]
- mdiDBPortNumber :: Lens' ModifyDBInstance (Maybe Int)
- mdiMasterUserPassword :: Lens' ModifyDBInstance (Maybe Text)
- mdiPubliclyAccessible :: Lens' ModifyDBInstance (Maybe Bool)
- mdiAutoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool)
- mdiMonitoringRoleARN :: Lens' ModifyDBInstance (Maybe Text)
- mdiIOPS :: Lens' ModifyDBInstance (Maybe Int)
- mdiAllowMajorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool)
- mdiNewDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text)
- mdiMonitoringInterval :: Lens' ModifyDBInstance (Maybe Int)
- mdiTDECredentialPassword :: Lens' ModifyDBInstance (Maybe Text)
- mdiDBInstanceClass :: Lens' ModifyDBInstance (Maybe Text)
- mdiPreferredMaintenanceWindow :: Lens' ModifyDBInstance (Maybe Text)
- mdiCACertificateIdentifier :: Lens' ModifyDBInstance (Maybe Text)
- mdiDBParameterGroupName :: Lens' ModifyDBInstance (Maybe Text)
- mdiPreferredBackupWindow :: Lens' ModifyDBInstance (Maybe Text)
- mdiBackupRetentionPeriod :: Lens' ModifyDBInstance (Maybe Int)
- mdiVPCSecurityGroupIds :: Lens' ModifyDBInstance [Text]
- mdiMultiAZ :: Lens' ModifyDBInstance (Maybe Bool)
- mdiAllocatedStorage :: Lens' ModifyDBInstance (Maybe Int)
- mdiApplyImmediately :: Lens' ModifyDBInstance (Maybe Bool)
- mdiOptionGroupName :: Lens' ModifyDBInstance (Maybe Text)
- mdiCopyTagsToSnapshot :: Lens' ModifyDBInstance (Maybe Bool)
- mdiTDECredentialARN :: Lens' ModifyDBInstance (Maybe Text)
- mdiStorageType :: Lens' ModifyDBInstance (Maybe Text)
- mdiDBInstanceIdentifier :: Lens' ModifyDBInstance Text
- modifyDBInstanceResponse :: Int -> ModifyDBInstanceResponse
- data ModifyDBInstanceResponse
- mdirsDBInstance :: Lens' ModifyDBInstanceResponse (Maybe DBInstance)
- mdirsResponseStatus :: Lens' ModifyDBInstanceResponse Int
Creating a Request
Creates a value of ModifyDBInstance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdiEngineVersion
mdiDBSecurityGroups
mdiDBPortNumber
mdiMasterUserPassword
mdiPubliclyAccessible
mdiAutoMinorVersionUpgrade
mdiMonitoringRoleARN
mdiIOPS
mdiAllowMajorVersionUpgrade
mdiNewDBInstanceIdentifier
mdiMonitoringInterval
mdiTDECredentialPassword
mdiDBInstanceClass
mdiPreferredMaintenanceWindow
mdiCACertificateIdentifier
mdiDBParameterGroupName
mdiPreferredBackupWindow
mdiBackupRetentionPeriod
mdiVPCSecurityGroupIds
mdiMultiAZ
mdiAllocatedStorage
mdiApplyImmediately
mdiOptionGroupName
mdiCopyTagsToSnapshot
mdiTDECredentialARN
mdiStorageType
mdiDBInstanceIdentifier
data ModifyDBInstance Source
See: modifyDBInstance
smart constructor.
Request Lenses
mdiEngineVersion :: Lens' ModifyDBInstance (Maybe Text) Source
The version number of the database engine to upgrade to. Changing this
parameter results in an outage and the change is applied during the next
maintenance window unless the ApplyImmediately
parameter is set to
true
for this request.
For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For a list of valid engine versions, see CreateDBInstance.
mdiDBSecurityGroups :: Lens' ModifyDBInstance [Text] Source
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
mdiDBPortNumber :: Lens' ModifyDBInstance (Maybe Int) Source
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.
MySQL
Default: '3306'
Valid Values: '1150-65535'
MariaDB
Default: '3306'
Valid Values: '1150-65535'
PostgreSQL
Default: '5432'
Valid Values: '1150-65535'
Oracle
Default: '1521'
Valid Values: '1150-65535'
SQL Server
Default: '1433'
Valid Values: '1150-65535' except for '1434', '3389', '47001', '49152', and '49152' through '49156'.
Amazon Aurora
Default: '3306'
Valid Values: '1150-65535'
mdiMasterUserPassword :: Lens' ModifyDBInstance (Maybe Text) Source
The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "'".
Changing this parameter does not result in an outage and the change is
asynchronously applied as soon as possible. Between the time of the
request and the completion of the request, the MasterUserPassword
element exists in the PendingModifiedValues
element of the operation
response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
mdiPubliclyAccessible :: Lens' ModifyDBInstance (Maybe Bool) Source
Boolean value that indicates if the DB instance has a publicly
resolvable DNS name. Set to True
to make the DB instance
Internet-facing with a publicly resolvable DNS name, which resolves to a
public IP address. Set to False
to make the DB instance internal with
a DNS name that resolves to a private IP address.
PubliclyAccessible
only applies to DB instances in a VPC. The DB
instance must be part of a public subnet and PubliclyAccessible
must
be true in order for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately
regardless of the value of the ApplyImmediately
parameter.
Default: false
mdiAutoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) Source
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window. Changing this parameter
does not 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 RDS has enabled auto patching for
that engine version.
mdiMonitoringRoleARN :: Lens' ModifyDBInstance (Maybe Text) Source
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, 'arn:aws:iam:123456789012:role\/emaccess'. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval
is set to a value other than 0, then you must
supply a MonitoringRoleArn
value.
mdiIOPS :: Lens' ModifyDBInstance (Maybe Int) Source
The new Provisioned IOPS (I/O operations per second) value for the RDS
instance. Changing this setting does not 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
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
mdiAllowMajorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) Source
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
mdiNewDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source
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 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
mdiMonitoringInterval :: Lens' ModifyDBInstance (Maybe Int) Source
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 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'
mdiTDECredentialPassword :: Lens' ModifyDBInstance (Maybe Text) Source
The password for the given ARN from the Key Store in order to access the device.
mdiDBInstanceClass :: Lens' ModifyDBInstance (Maybe Text) Source
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and
is applied during the next maintenance window, unless ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting
Valid Values: 'db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large'
mdiPreferredMaintenanceWindow :: Lens' ModifyDBInstance (Maybe Text) Source
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not 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
mdiCACertificateIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source
Indicates the certificate that needs to be associated with the instance.
mdiDBParameterGroupName :: Lens' ModifyDBInstance (Maybe Text) Source
The name of the DB parameter group to apply to the DB instance. Changing this setting does not 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.
mdiPreferredBackupWindow :: Lens' ModifyDBInstance (Maybe Text) Source
The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this parameter does not
result in an outage and the change is asynchronously applied as soon as
possible.
Constraints:
- Must be in the format hh24:mi-hh24:mi
- Times should be in Universal Time Coordinated (UTC)
- Must not conflict with the preferred maintenance window
- Must be at least 30 minutes
mdiBackupRetentionPeriod :: Lens' ModifyDBInstance (Maybe Int) Source
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to
a non-zero value or from a non-zero value to 0. These changes are
applied during the next maintenance window unless the ApplyImmediately
parameter is set to true
for this request. If you change the parameter
from one non-zero value to another non-zero value, the change is
asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
- Must be a value from 0 to 35
- Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
- Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
- Cannot be set to 0 if the DB instance is a source to Read Replicas
mdiVPCSecurityGroupIds :: Lens' ModifyDBInstance [Text] Source
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
mdiMultiAZ :: Lens' ModifyDBInstance (Maybe Bool) Source
Specifies if the DB instance is a Multi-AZ deployment. Changing this
parameter does not 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.
Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
mdiAllocatedStorage :: Lens' ModifyDBInstance (Maybe Int) Source
The new storage capacity of the RDS instance. Changing this setting does
not result in an outage and the change is applied during the next
maintenance window unless ApplyImmediately
is set to true
for this
request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
mdiApplyImmediately :: Lens' ModifyDBInstance (Maybe Bool) Source
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 will be applied on the next call to
RebootDBInstance, or the next failure reboot. Review the table of
parameters in
Modifying a DB Instance and Using the Apply Immediately Parameter
to see the impact that setting ApplyImmediately
to true
or false
has for each modified parameter and to determine when the changes will
be applied.
Default: false
mdiOptionGroupName :: Lens' ModifyDBInstance (Maybe Text) Source
Indicates that the DB instance should be associated with the specified
option group. Changing this parameter does not result in an outage
except in the following case and the change is applied during the next
maintenance window unless the ApplyImmediately
parameter is set to
true
for this request. If the parameter change results in an option
group that enables OEM, this change can cause a brief (sub-second)
period during which new connections are rejected but existing
connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
mdiCopyTagsToSnapshot :: Lens' ModifyDBInstance (Maybe Bool) Source
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
mdiTDECredentialARN :: Lens' ModifyDBInstance (Maybe Text) Source
The ARN from the Key Store with which to associate the instance for TDE encryption.
mdiStorageType :: Lens' ModifyDBInstance (Maybe Text) Source
Specifies the storage type to be associated with the DB instance.
Valid values: 'standard | gp2 | io1'
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise
standard
mdiDBInstanceIdentifier :: Lens' ModifyDBInstance Text Source
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
- Must be the identifier for an existing DB instance
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Destructuring the Response
modifyDBInstanceResponse Source
Creates a value of ModifyDBInstanceResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ModifyDBInstanceResponse Source
See: modifyDBInstanceResponse
smart constructor.
Response Lenses
mdirsDBInstance :: Lens' ModifyDBInstanceResponse (Maybe DBInstance) Source
Undocumented member.
mdirsResponseStatus :: Lens' ModifyDBInstanceResponse Int Source
The response status code.