ReplicationInstance
¶
Source code in docs_src/capo_database_migration_service/types/replication_instance.py
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.