Skip to main content

replication_instances

Creates, updates, deletes, gets or lists a replication_instances resource.

Overview​

Namereplication_instances
TypeResource
Idaws.dms.replication_instances

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
allocated_storageintegerThe amount of storage (in gigabytes) that is allocated for the replication instance.
auto_minor_version_upgradebooleanBoolean value indicating if minor version upgrades will be automatically applied to the instance.
availability_zonestringThe Availability Zone for the instance.
dns_name_serversstringThe DNS name servers supported for the replication instance to access your on-premise source or target database.
engine_versionstringThe 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_untilstring (date-time)The expiration date of the free replication instance that is part of the Free DMS program.
instance_create_timestring (date-time)The time the replication instance was created.
kerberos_authentication_settingsobjectSpecifies the settings required for kerberos authentication when replicating an instance.
kms_key_idstringAn 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_azbooleanSpecifies 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_typestringThe 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_valuesobjectThe pending modification values.
preferred_maintenance_windowstringThe maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
publicly_accessiblebooleanSpecifies 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_arnstringThe Amazon Resource Name (ARN) of the replication instance.
replication_instance_classstringThe 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_identifierstringThe 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_ipv_6_addressesarrayOne or more IPv6 addresses for the replication instance.
replication_instance_private_ip_addressstringThe private IP address of the replication instance.
replication_instance_private_ip_addressesarrayOne or more private IP addresses for the replication instance.
replication_instance_public_ip_addressstringThe public IP address of the replication instance.
replication_instance_public_ip_addressesarrayOne or more public IP addresses for the replication instance.
replication_instance_statusstringThe 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_groupobjectThe subnet group for the replication instance.
secondary_availability_zonestringThe Availability Zone of the standby replication instance in a Multi-AZ deployment.
vpc_security_groupsarrayThe VPC security group for the instance.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_replication_instancesselectregionReturns information about replication instances for your account in the current region.
create_replication_instanceinsertregion, ReplicationInstanceIdentifier, ReplicationInstanceClassCreates the replication instance using the specified parameters. DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS. If you don't specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see Release Notes.
modify_replication_instanceupdateregion, ReplicationInstanceArnModifies 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.
delete_replication_instancedeleteregionDeletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
apply_pending_maintenance_actionexecregion, ReplicationInstanceArn, ApplyAction, OptInTypeApplies a pending maintenance action to a resource (for example, to a replication instance).
test_connectionexecregion, ReplicationInstanceArn, EndpointArnTests the connection between the replication instance and the endpoint.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Returns information about replication instances for your account in the current region.

SELECT
allocated_storage,
auto_minor_version_upgrade,
availability_zone,
dns_name_servers,
engine_version,
free_until,
instance_create_time,
kerberos_authentication_settings,
kms_key_id,
multi_az,
network_type,
pending_modified_values,
preferred_maintenance_window,
publicly_accessible,
replication_instance_arn,
replication_instance_class,
replication_instance_identifier,
replication_instance_ipv_6_addresses,
replication_instance_private_ip_address,
replication_instance_private_ip_addresses,
replication_instance_public_ip_address,
replication_instance_public_ip_addresses,
replication_instance_status,
replication_subnet_group,
secondary_availability_zone,
vpc_security_groups
FROM aws.dms.replication_instances
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates the replication instance using the specified parameters. DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS. If you don't specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see Release Notes.

INSERT INTO aws.dms.replication_instances (
ReplicationInstanceIdentifier,
AllocatedStorage,
ReplicationInstanceClass,
VpcSecurityGroupIds,
AvailabilityZone,
ReplicationSubnetGroupIdentifier,
PreferredMaintenanceWindow,
MultiAZ,
EngineVersion,
AutoMinorVersionUpgrade,
Tags,
KmsKeyId,
PubliclyAccessible,
DnsNameServers,
ResourceIdentifier,
NetworkType,
KerberosAuthenticationSettings,
region
)
SELECT 
'{{ ReplicationInstanceIdentifier }}' /* required */,
{{ AllocatedStorage }},
'{{ ReplicationInstanceClass }}' /* required */,
'{{ VpcSecurityGroupIds }}',
'{{ AvailabilityZone }}',
'{{ ReplicationSubnetGroupIdentifier }}',
'{{ PreferredMaintenanceWindow }}',
{{ MultiAZ }},
'{{ EngineVersion }}',
{{ AutoMinorVersionUpgrade }},
'{{ Tags }}',
'{{ KmsKeyId }}',
{{ PubliclyAccessible }},
'{{ DnsNameServers }}',
'{{ ResourceIdentifier }}',
'{{ NetworkType }}',
'{{ KerberosAuthenticationSettings }}',
'{{ region }}'
RETURNING
replication_instance
;

UPDATE examples​

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.

UPDATE aws.dms.replication_instances
SET 
ReplicationInstanceArn = '{{ ReplicationInstanceArn }}',
AllocatedStorage = {{ AllocatedStorage }},
ApplyImmediately = {{ ApplyImmediately }},
ReplicationInstanceClass = '{{ ReplicationInstanceClass }}',
VpcSecurityGroupIds = '{{ VpcSecurityGroupIds }}',
PreferredMaintenanceWindow = '{{ PreferredMaintenanceWindow }}',
MultiAZ = {{ MultiAZ }},
EngineVersion = '{{ EngineVersion }}',
AllowMajorVersionUpgrade = {{ AllowMajorVersionUpgrade }},
AutoMinorVersionUpgrade = {{ AutoMinorVersionUpgrade }},
ReplicationInstanceIdentifier = '{{ ReplicationInstanceIdentifier }}',
NetworkType = '{{ NetworkType }}',
KerberosAuthenticationSettings = '{{ KerberosAuthenticationSettings }}'
WHERE 
region = '{{ region }}' --required
AND ReplicationInstanceArn = '{{ ReplicationInstanceArn }}' --required
RETURNING
replication_instance;

DELETE examples​

Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.

DELETE FROM aws.dms.replication_instances
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Applies a pending maintenance action to a resource (for example, to a replication instance).

EXEC aws.dms.replication_instances.apply_pending_maintenance_action 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationInstanceArn": "{{ ReplicationInstanceArn }}", 
"ApplyAction": "{{ ApplyAction }}", 
"OptInType": "{{ OptInType }}"
}'
;
Last updated on