Skip to content

ReplicationInstance

Source code in docs_src/capo_database_migration_service/types/replication_instance.py
class ReplicationInstance(TypedDict, closed=True):
    replication_instance_identifier: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </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. It is a required parameter, although a default value is pre-selected in the DMS console.</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>"""
    replication_instance_status: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The status of the replication instance. The possible return values include:</p> <ul> <li> <p> <code>"available"</code> </p> </li> <li> <p> <code>"creating"</code> </p> </li> <li> <p> <code>"deleted"</code> </p> </li> <li> <p> <code>"deleting"</code> </p> </li> <li> <p> <code>"failed"</code> </p> </li> <li> <p> <code>"modifying"</code> </p> </li> <li> <p> <code>"upgrading"</code> </p> </li> <li> <p> <code>"rebooting"</code> </p> </li> <li> <p> <code>"resetting-master-credentials"</code> </p> </li> <li> <p> <code>"storage-full"</code> </p> </li> <li> <p> <code>"incompatible-credentials"</code> </p> </li> <li> <p> <code>"incompatible-network"</code> </p> </li> <li> <p> <code>"maintenance"</code> </p> </li> </ul>"""
    allocated_storage: "capo_database_migration_service.types.integer.Integer"
    """<p>The amount of storage (in gigabytes) that is allocated for the replication instance.</p>"""
    instance_create_time: NotRequired[
        "capo_database_migration_service.types.t_stamp.TStamp"
    ]
    """<p>The time the replication instance was created.</p>"""
    vpc_security_groups: NotRequired[
        "capo_database_migration_service.types.vpc_security_group_membership_list.VpcSecurityGroupMembershipList"
    ]
    """<p>The VPC security group for the instance.</p>"""
    availability_zone: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The Availability Zone for the instance.</p>"""
    replication_subnet_group: NotRequired[
        "capo_database_migration_service.types.replication_subnet_group.ReplicationSubnetGroup"
    ]
    """<p>The subnet group for the replication instance.</p>"""
    preferred_maintenance_window: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.</p>"""
    pending_modified_values: NotRequired[
        "capo_database_migration_service.types.replication_pending_modified_values.ReplicationPendingModifiedValues"
    ]
    """<p>The pending modification values.</p>"""
    multi_az: "capo_database_migration_service.types.boolean.Boolean"
    """<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>If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.</p> <p>When modifying a major engine version of an instance, also set <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</p>"""
    auto_minor_version_upgrade: "capo_database_migration_service.types.boolean.Boolean"
    """<p>Boolean value indicating if minor version upgrades will be automatically applied to the instance.</p>"""
    kms_key_id: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>An KMS key identifier that is used to encrypt the data on the replication instance.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.</p>"""
    replication_instance_arn: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The Amazon Resource Name (ARN) of the replication instance.</p>"""
    replication_instance_public_ip_address: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The public IP address of the replication instance.</p>"""
    replication_instance_private_ip_address: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The private IP address of the replication instance.</p>"""
    replication_instance_public_ip_addresses: NotRequired[
        "capo_database_migration_service.types.replication_instance_public_ip_address_list.ReplicationInstancePublicIpAddressList"
    ]
    """<p>One or more public IP addresses for the replication instance.</p>"""
    replication_instance_private_ip_addresses: NotRequired[
        "capo_database_migration_service.types.replication_instance_private_ip_address_list.ReplicationInstancePrivateIpAddressList"
    ]
    """<p>One or more private IP addresses for the replication instance.</p>"""
    replication_instance_ipv6_addresses: NotRequired[
        "capo_database_migration_service.types.replication_instance_ipv6_address_list.ReplicationInstanceIpv6AddressList"
    ]
    """<p>One or more IPv6 addresses for the replication instance.</p>"""
    publicly_accessible: "capo_database_migration_service.types.boolean.Boolean"
    """<p> Specifies the accessibility options for the replication instance. A value of <code>true</code> represents an instance with a public IP address. A value of <code>false</code> represents an instance with a private IP address. The default value is <code>true</code>. </p>"""
    secondary_availability_zone: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The Availability Zone of the standby replication instance in a Multi-AZ deployment.</p>"""
    free_until: NotRequired["capo_database_migration_service.types.t_stamp.TStamp"]
    """<p> The expiration date of the free replication instance that is part of the Free DMS program. </p>"""
    dns_name_servers: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The DNS name servers supported for the replication instance to access your on-premise source or target database.</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 replicating an instance.</p>"""

allocated_storage instance-attribute

allocated_storage: Integer

The amount of storage (in gigabytes) that is allocated for the replication instance.

auto_minor_version_upgrade instance-attribute

auto_minor_version_upgrade: Boolean

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

availability_zone instance-attribute

availability_zone: NotRequired[String]

The Availability Zone for the instance.

dns_name_servers instance-attribute

dns_name_servers: NotRequired[String]

The DNS name servers supported for the replication instance to access your on-premise source or target database.

engine_version instance-attribute

engine_version: NotRequired[String]

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

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

free_until instance-attribute

free_until: NotRequired[TStamp]

The expiration date of the free replication instance that is part of the Free DMS program.

instance_create_time instance-attribute

instance_create_time: NotRequired[TStamp]

The time the replication instance was created.

kerberos_authentication_settings instance-attribute

kerberos_authentication_settings: NotRequired[KerberosAuthenticationSettings]

Specifies the settings required for kerberos authentication when replicating an instance.

kms_key_id instance-attribute

kms_key_id: NotRequired[String]

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

multi_az instance-attribute

multi_az: Boolean

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.

pending_modified_values instance-attribute

pending_modified_values: NotRequired[ReplicationPendingModifiedValues]

The pending modification values.

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[String]

The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

publicly_accessible instance-attribute

publicly_accessible: Boolean

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

replication_instance_arn instance-attribute

replication_instance_arn: NotRequired[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. It is a required parameter, although a default value is pre-selected in the DMS console.

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 is a required parameter. This parameter is stored as a lowercase string.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

replication_instance_ipv6_addresses instance-attribute

replication_instance_ipv6_addresses: NotRequired[ReplicationInstanceIpv6AddressList]

One or more IPv6 addresses for the replication instance.

replication_instance_private_ip_address instance-attribute

replication_instance_private_ip_address: NotRequired[String]

The private IP address of the replication instance.

replication_instance_private_ip_addresses instance-attribute

replication_instance_private_ip_addresses: NotRequired[
    ReplicationInstancePrivateIpAddressList
]

One or more private IP addresses for the replication instance.

replication_instance_public_ip_address instance-attribute

replication_instance_public_ip_address: NotRequired[String]

The public IP address of the replication instance.

replication_instance_public_ip_addresses instance-attribute

replication_instance_public_ip_addresses: NotRequired[
    ReplicationInstancePublicIpAddressList
]

One or more public IP addresses for the replication instance.

replication_instance_status instance-attribute

replication_instance_status: NotRequired[String]

The status of the replication instance. The possible return values include:

  • "available"

  • "creating"

  • "deleted"

  • "deleting"

  • "failed"

  • "modifying"

  • "upgrading"

  • "rebooting"

  • "resetting-master-credentials"

  • "storage-full"

  • "incompatible-credentials"

  • "incompatible-network"

  • "maintenance"

replication_subnet_group instance-attribute

replication_subnet_group: NotRequired[ReplicationSubnetGroup]

The subnet group for the replication instance.

secondary_availability_zone instance-attribute

secondary_availability_zone: NotRequired[String]

The Availability Zone of the standby replication instance in a Multi-AZ deployment.

vpc_security_groups instance-attribute

vpc_security_groups: NotRequired[VpcSecurityGroupMembershipList]

The VPC security group for the instance.