Skip to content

ModifyReplicationInstanceMessage

Source code in docs_src/capo_database_migration_service/types/modify_replication_instance_message.py
class ModifyReplicationInstanceMessage(TypedDict, closed=True):
    replication_instance_arn: "capo_database_migration_service.types.string.String"
    """<p>The Amazon Resource Name (ARN) of the replication instance.</p>"""
    allocated_storage: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The amount of storage (in gigabytes) to be allocated for the replication instance.</p>"""
    apply_immediately: "capo_database_migration_service.types.boolean.Boolean"
    """<p>Indicates whether the changes should be applied immediately or during the next maintenance window.</p>"""
    replication_instance_class: NotRequired[
        "capo_database_migration_service.types.replication_instance_class.ReplicationInstanceClass"
    ]
    """<p>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 <code>"dms.c4.large"</code>.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth"> Selecting the right DMS replication instance for your migration</a>. </p>"""
    vpc_security_group_ids: NotRequired[
        "capo_database_migration_service.types.vpc_security_group_id_list.VpcSecurityGroupIdList"
    ]
    """<p> 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. </p>"""
    preferred_maintenance_window: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>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.</p> <p>Default: Uses existing setting</p> <p>Format: ddd:hh24:mi-ddd:hh24:mi</p> <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p> <p>Constraints: Must be at least 30 minutes</p>"""
    multi_az: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"""
    engine_version: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The engine version number of the replication instance.</p> <p>When modifying a major engine version of an instance, also set <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</p>"""
    allow_major_version_upgrade: "capo_database_migration_service.types.boolean.Boolean"
    """<p>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.</p> <p>This parameter must be set to <code>true</code> when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the replication instance's current version.</p>"""
    auto_minor_version_upgrade: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p>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. </p> <p>An outage does result if these factors apply: </p> <ul> <li> <p>This parameter is set to <code>true</code> during the maintenance window.</p> </li> <li> <p>A newer minor version is available. </p> </li> <li> <p>DMS has enabled automatic patching for the given engine version. </p> </li> </ul>"""
    replication_instance_identifier: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The replication instance identifier. This parameter is stored as a lowercase string.</p>"""
    network_type: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>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.</p>"""
    kerberos_authentication_settings: NotRequired[
        "capo_database_migration_service.types.kerberos_authentication_settings.KerberosAuthenticationSettings"
    ]
    """<p>Specifies the settings required for kerberos authentication when modifying a replication instance.</p>"""

allocated_storage instance-attribute

allocated_storage: NotRequired[IntegerOptional]

The amount of storage (in gigabytes) to be allocated for the replication instance.

allow_major_version_upgrade instance-attribute

allow_major_version_upgrade: Boolean

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.

apply_immediately instance-attribute

apply_immediately: Boolean

Indicates whether the changes should be applied immediately or during the next maintenance window.

auto_minor_version_upgrade instance-attribute

auto_minor_version_upgrade: NotRequired[BooleanOptional]

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.

engine_version instance-attribute

engine_version: NotRequired[String]

The engine version number of the replication instance.

When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

kerberos_authentication_settings instance-attribute

kerberos_authentication_settings: NotRequired[KerberosAuthenticationSettings]

Specifies the settings required for kerberos authentication when modifying a replication instance.

multi_az instance-attribute

multi_az: NotRequired[BooleanOptional]

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.

network_type instance-attribute

network_type: NotRequired[String]

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.

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[String]

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

replication_instance_arn instance-attribute

replication_instance_arn: String

The Amazon Resource Name (ARN) of the replication instance.

replication_instance_class instance-attribute

replication_instance_class: NotRequired[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.

replication_instance_identifier instance-attribute

replication_instance_identifier: NotRequired[String]

The replication instance identifier. This parameter is stored as a lowercase string.

vpc_security_group_ids instance-attribute

vpc_security_group_ids: NotRequired[VpcSecurityGroupIdList]

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.