Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
Synopsis
- data ModifyDBInstance = ModifyDBInstance' {
- applyImmediately :: Maybe Bool
- autoMinorVersionUpgrade :: Maybe Bool
- cACertificateIdentifier :: Maybe Text
- copyTagsToSnapshot :: Maybe Bool
- dbInstanceClass :: Maybe Text
- enablePerformanceInsights :: Maybe Bool
- newDBInstanceIdentifier' :: Maybe Text
- performanceInsightsKMSKeyId :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- promotionTier :: Maybe Int
- dbInstanceIdentifier :: Text
- newModifyDBInstance :: Text -> ModifyDBInstance
- modifyDBInstance_applyImmediately :: Lens' ModifyDBInstance (Maybe Bool)
- modifyDBInstance_autoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool)
- modifyDBInstance_cACertificateIdentifier :: Lens' ModifyDBInstance (Maybe Text)
- modifyDBInstance_copyTagsToSnapshot :: Lens' ModifyDBInstance (Maybe Bool)
- modifyDBInstance_dbInstanceClass :: Lens' ModifyDBInstance (Maybe Text)
- modifyDBInstance_enablePerformanceInsights :: Lens' ModifyDBInstance (Maybe Bool)
- modifyDBInstance_newDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text)
- modifyDBInstance_performanceInsightsKMSKeyId :: Lens' ModifyDBInstance (Maybe Text)
- modifyDBInstance_preferredMaintenanceWindow :: Lens' ModifyDBInstance (Maybe Text)
- modifyDBInstance_promotionTier :: Lens' ModifyDBInstance (Maybe Int)
- modifyDBInstance_dbInstanceIdentifier :: Lens' ModifyDBInstance Text
- data ModifyDBInstanceResponse = ModifyDBInstanceResponse' {}
- newModifyDBInstanceResponse :: Int -> ModifyDBInstanceResponse
- modifyDBInstanceResponse_dbInstance :: Lens' ModifyDBInstanceResponse (Maybe DBInstance)
- modifyDBInstanceResponse_httpStatus :: Lens' ModifyDBInstanceResponse Int
Creating a Request
data ModifyDBInstance Source #
Represents the input to ModifyDBInstance.
See: newModifyDBInstance
smart constructor.
ModifyDBInstance' | |
|
Instances
Create a value of ModifyDBInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applyImmediately:ModifyDBInstance'
, modifyDBInstance_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 instance.
If this parameter is set to false
, changes to the instance are applied
during the next maintenance window. Some parameter changes can cause an
outage and are applied on the next reboot.
Default: false
ModifyDBInstance
, modifyDBInstance_autoMinorVersionUpgrade
- This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
does not perform minor version upgrades regardless of the value set.
ModifyDBInstance
, modifyDBInstance_cACertificateIdentifier
- Indicates the certificate that needs to be associated with the instance.
ModifyDBInstance
, modifyDBInstance_copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB instance to
snapshots of the DB instance. By default, tags are not copied.
ModifyDBInstance
, modifyDBInstance_dbInstanceClass
- The new compute and memory capacity of the instance; for example,
db.r5.large
. Not all instance classes are available in all Amazon Web
Services Regions.
If you modify the 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.
$sel:enablePerformanceInsights:ModifyDBInstance'
, modifyDBInstance_enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB
Instance. For more information, see
Using Amazon Performance Insights.
$sel:newDBInstanceIdentifier':ModifyDBInstance'
, modifyDBInstance_newDBInstanceIdentifier
- The new instance identifier for the instance when renaming an instance.
When you change the instance identifier, an instance reboot occurs
immediately if you set Apply Immediately
to true
. It occurs during
the next maintenance window if you set 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
$sel:performanceInsightsKMSKeyId:ModifyDBInstance'
, modifyDBInstance_performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
ModifyDBInstance
, modifyDBInstance_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, changing this parameter causes a reboot of the
instance. If you are 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 that 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.
ModifyDBInstance
, modifyDBInstance_promotionTier
- A value that specifies the order in which an Amazon DocumentDB replica
is promoted to the primary instance after a failure of the existing
primary instance.
Default: 1
Valid values: 0-15
ModifyDBInstance
, modifyDBInstance_dbInstanceIdentifier
- The instance identifier. This value is stored as a lowercase string.
Constraints:
- Must match the identifier of an existing
DBInstance
.
Request Lenses
modifyDBInstance_applyImmediately :: 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 instance.
If this parameter is set to false
, changes to the instance are applied
during the next maintenance window. Some parameter changes can cause an
outage and are applied on the next reboot.
Default: false
modifyDBInstance_autoMinorVersionUpgrade :: Lens' ModifyDBInstance (Maybe Bool) Source #
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
modifyDBInstance_cACertificateIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source #
Indicates the certificate that needs to be associated with the instance.
modifyDBInstance_copyTagsToSnapshot :: Lens' ModifyDBInstance (Maybe Bool) Source #
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
modifyDBInstance_dbInstanceClass :: Lens' ModifyDBInstance (Maybe Text) Source #
The new compute and memory capacity of the instance; for example,
db.r5.large
. Not all instance classes are available in all Amazon Web
Services Regions.
If you modify the 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.
modifyDBInstance_enablePerformanceInsights :: Lens' ModifyDBInstance (Maybe Bool) Source #
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
modifyDBInstance_newDBInstanceIdentifier :: Lens' ModifyDBInstance (Maybe Text) Source #
The new instance identifier for the instance when renaming an instance.
When you change the instance identifier, an instance reboot occurs
immediately if you set Apply Immediately
to true
. It occurs during
the next maintenance window if you set 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
modifyDBInstance_performanceInsightsKMSKeyId :: Lens' ModifyDBInstance (Maybe Text) Source #
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
modifyDBInstance_preferredMaintenanceWindow :: 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 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, changing this parameter causes a reboot of the instance. If you are 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 that 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.
modifyDBInstance_promotionTier :: Lens' ModifyDBInstance (Maybe Int) Source #
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
modifyDBInstance_dbInstanceIdentifier :: Lens' ModifyDBInstance Text Source #
The instance identifier. This value is stored as a lowercase string.
Constraints:
- Must match the identifier of an existing
DBInstance
.
Destructuring the Response
data ModifyDBInstanceResponse Source #
See: newModifyDBInstanceResponse
smart constructor.
ModifyDBInstanceResponse' | |
|
Instances
newModifyDBInstanceResponse Source #
Create a value of ModifyDBInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:ModifyDBInstanceResponse'
, modifyDBInstanceResponse_dbInstance
- Undocumented member.
$sel:httpStatus:ModifyDBInstanceResponse'
, modifyDBInstanceResponse_httpStatus
- The response's http status code.
Response Lenses
modifyDBInstanceResponse_dbInstance :: Lens' ModifyDBInstanceResponse (Maybe DBInstance) Source #
Undocumented member.
modifyDBInstanceResponse_httpStatus :: Lens' ModifyDBInstanceResponse Int Source #
The response's http status code.