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 the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
Synopsis
- data ModifyReplicationInstance = ModifyReplicationInstance' {
- allocatedStorage :: Maybe Int
- allowMajorVersionUpgrade :: Maybe Bool
- applyImmediately :: Maybe Bool
- autoMinorVersionUpgrade :: Maybe Bool
- engineVersion :: Maybe Text
- multiAZ :: Maybe Bool
- networkType :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- replicationInstanceClass :: Maybe Text
- replicationInstanceIdentifier :: Maybe Text
- vpcSecurityGroupIds :: Maybe [Text]
- replicationInstanceArn :: Text
- newModifyReplicationInstance :: Text -> ModifyReplicationInstance
- modifyReplicationInstance_allocatedStorage :: Lens' ModifyReplicationInstance (Maybe Int)
- modifyReplicationInstance_allowMajorVersionUpgrade :: Lens' ModifyReplicationInstance (Maybe Bool)
- modifyReplicationInstance_applyImmediately :: Lens' ModifyReplicationInstance (Maybe Bool)
- modifyReplicationInstance_autoMinorVersionUpgrade :: Lens' ModifyReplicationInstance (Maybe Bool)
- modifyReplicationInstance_engineVersion :: Lens' ModifyReplicationInstance (Maybe Text)
- modifyReplicationInstance_multiAZ :: Lens' ModifyReplicationInstance (Maybe Bool)
- modifyReplicationInstance_networkType :: Lens' ModifyReplicationInstance (Maybe Text)
- modifyReplicationInstance_preferredMaintenanceWindow :: Lens' ModifyReplicationInstance (Maybe Text)
- modifyReplicationInstance_replicationInstanceClass :: Lens' ModifyReplicationInstance (Maybe Text)
- modifyReplicationInstance_replicationInstanceIdentifier :: Lens' ModifyReplicationInstance (Maybe Text)
- modifyReplicationInstance_vpcSecurityGroupIds :: Lens' ModifyReplicationInstance (Maybe [Text])
- modifyReplicationInstance_replicationInstanceArn :: Lens' ModifyReplicationInstance Text
- data ModifyReplicationInstanceResponse = ModifyReplicationInstanceResponse' {}
- newModifyReplicationInstanceResponse :: Int -> ModifyReplicationInstanceResponse
- modifyReplicationInstanceResponse_replicationInstance :: Lens' ModifyReplicationInstanceResponse (Maybe ReplicationInstance)
- modifyReplicationInstanceResponse_httpStatus :: Lens' ModifyReplicationInstanceResponse Int
Creating a Request
data ModifyReplicationInstance Source #
See: newModifyReplicationInstance
smart constructor.
ModifyReplicationInstance' | |
|
Instances
newModifyReplicationInstance Source #
Create a value of ModifyReplicationInstance
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:
ModifyReplicationInstance
, modifyReplicationInstance_allocatedStorage
- The amount of storage (in gigabytes) to be allocated for the replication
instance.
$sel:allowMajorVersionUpgrade:ModifyReplicationInstance'
, modifyReplicationInstance_allowMajorVersionUpgrade
- 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.
This parameter must be set to true
when specifying a value for the
EngineVersion
parameter that is a different major version than the
replication instance's current version.
$sel:applyImmediately:ModifyReplicationInstance'
, modifyReplicationInstance_applyImmediately
- Indicates whether the changes should be applied immediately or during
the next maintenance window.
ModifyReplicationInstance
, modifyReplicationInstance_autoMinorVersionUpgrade
- A value that indicates that minor version upgrades are applied
automatically to the replication instance during the maintenance window.
Changing this parameter doesn't result in an outage, except in the case
described following. The change is asynchronously applied as soon as
possible.
An outage does result if these factors apply:
- This parameter is set to
true
during the maintenance window. - A newer minor version is available.
- DMS has enabled automatic patching for the given engine version.
ModifyReplicationInstance
, modifyReplicationInstance_engineVersion
- The engine version number of the replication instance.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgrade
to true
.
ModifyReplicationInstance
, modifyReplicationInstance_multiAZ
- Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone
parameter if the Multi-AZ parameter is
set to true
.
ModifyReplicationInstance
, modifyReplicationInstance_networkType
- The type of IP address protocol used by a replication instance, such as
IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing.
IPv6 only is not yet supported.
ModifyReplicationInstance
, modifyReplicationInstance_preferredMaintenanceWindow
- 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 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
ModifyReplicationInstance
, modifyReplicationInstance_replicationInstanceClass
- The compute and memory capacity of the replication instance as defined
for the specified replication instance class. For example to specify the
instance class dms.c4.large, set this parameter to "dms.c4.large"
.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ModifyReplicationInstance
, modifyReplicationInstance_replicationInstanceIdentifier
- The replication instance identifier. This parameter is stored as a
lowercase string.
$sel:vpcSecurityGroupIds:ModifyReplicationInstance'
, modifyReplicationInstance_vpcSecurityGroupIds
- Specifies the VPC security group to be used with the replication
instance. The VPC security group must work with the VPC containing the
replication instance.
ModifyReplicationInstance
, modifyReplicationInstance_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
Request Lenses
modifyReplicationInstance_allocatedStorage :: Lens' ModifyReplicationInstance (Maybe Int) Source #
The amount of storage (in gigabytes) to be allocated for the replication instance.
modifyReplicationInstance_allowMajorVersionUpgrade :: Lens' ModifyReplicationInstance (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.
This parameter must be set to true
when specifying a value for the
EngineVersion
parameter that is a different major version than the
replication instance's current version.
modifyReplicationInstance_applyImmediately :: Lens' ModifyReplicationInstance (Maybe Bool) Source #
Indicates whether the changes should be applied immediately or during the next maintenance window.
modifyReplicationInstance_autoMinorVersionUpgrade :: Lens' ModifyReplicationInstance (Maybe Bool) Source #
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
- This parameter is set to
true
during the maintenance window. - A newer minor version is available.
- DMS has enabled automatic patching for the given engine version.
modifyReplicationInstance_engineVersion :: Lens' ModifyReplicationInstance (Maybe Text) Source #
The engine version number of the replication instance.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgrade
to true
.
modifyReplicationInstance_multiAZ :: Lens' ModifyReplicationInstance (Maybe Bool) Source #
Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone
parameter if the Multi-AZ parameter is
set to true
.
modifyReplicationInstance_networkType :: Lens' ModifyReplicationInstance (Maybe Text) Source #
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
modifyReplicationInstance_preferredMaintenanceWindow :: Lens' ModifyReplicationInstance (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 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
modifyReplicationInstance_replicationInstanceClass :: Lens' ModifyReplicationInstance (Maybe Text) Source #
The compute and memory capacity of the replication instance as defined
for the specified replication instance class. For example to specify the
instance class dms.c4.large, set this parameter to "dms.c4.large"
.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
modifyReplicationInstance_replicationInstanceIdentifier :: Lens' ModifyReplicationInstance (Maybe Text) Source #
The replication instance identifier. This parameter is stored as a lowercase string.
modifyReplicationInstance_vpcSecurityGroupIds :: Lens' ModifyReplicationInstance (Maybe [Text]) Source #
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
modifyReplicationInstance_replicationInstanceArn :: Lens' ModifyReplicationInstance Text Source #
The Amazon Resource Name (ARN) of the replication instance.
Destructuring the Response
data ModifyReplicationInstanceResponse Source #
See: newModifyReplicationInstanceResponse
smart constructor.
ModifyReplicationInstanceResponse' | |
|
Instances
Generic ModifyReplicationInstanceResponse Source # | |
Read ModifyReplicationInstanceResponse Source # | |
Show ModifyReplicationInstanceResponse Source # | |
Defined in Amazonka.DMS.ModifyReplicationInstance | |
NFData ModifyReplicationInstanceResponse Source # | |
Defined in Amazonka.DMS.ModifyReplicationInstance rnf :: ModifyReplicationInstanceResponse -> () # | |
Eq ModifyReplicationInstanceResponse Source # | |
type Rep ModifyReplicationInstanceResponse Source # | |
Defined in Amazonka.DMS.ModifyReplicationInstance type Rep ModifyReplicationInstanceResponse = D1 ('MetaData "ModifyReplicationInstanceResponse" "Amazonka.DMS.ModifyReplicationInstance" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "ModifyReplicationInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newModifyReplicationInstanceResponse Source #
Create a value of ModifyReplicationInstanceResponse
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:replicationInstance:ModifyReplicationInstanceResponse'
, modifyReplicationInstanceResponse_replicationInstance
- The modified replication instance.
$sel:httpStatus:ModifyReplicationInstanceResponse'
, modifyReplicationInstanceResponse_httpStatus
- The response's http status code.
Response Lenses
modifyReplicationInstanceResponse_replicationInstance :: Lens' ModifyReplicationInstanceResponse (Maybe ReplicationInstance) Source #
The modified replication instance.
modifyReplicationInstanceResponse_httpStatus :: Lens' ModifyReplicationInstanceResponse Int Source #
The response's http status code.