Skip to main content

Component: dms/replication-instance

This component provisions DMS replication instances.


Stack Level: Regional

Here are some example snippets for how to use this component:

type: abstract
workspace_enabled: true
autodeploy: false
enabled: true
allocated_storage: 50
apply_immediately: true
auto_minor_version_upgrade: true
allow_major_version_upgrade: false
availability_zone: null
engine_version: "3.4"
multi_az: false
preferred_maintenance_window: "sun:10:30-sun:14:30"
publicly_accessible: false

component: dms/replication-instance
- dms/replication-instance/defaults
# Replication instance name must start with a letter, only contain alphanumeric characters and hyphens
name: "t2-small"
replication_instance_class: "dms.t2.small"
allocated_storage: 50


terraform>= 1.2.0
aws>= 4.26.0


No providers.




No resources.


additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
allocated_storageThe amount of storage (in gigabytes) to be initially allocated for the replication instance. Default: 50, Min: 5, Max: 6144number50no
allow_major_version_upgradeIndicates that major version upgrades are allowedboolfalseno
apply_immediatelyIndicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resourcebooltrueno
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
auto_minor_version_upgradeIndicates that major version upgrades are allowedbooltrueno
availability_zoneThe EC2 Availability Zone that the replication instance will be created inanynullno
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
enabledSet to false to prevent the module from creating any resourcesboolnullno
engine_versionThe engine version number of the replication instancestring"3.4"no
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
multi_azSpecifies if the replication instance is a multi-az deployment. You cannot set the availability_zone parameter if the multi_az parameter is set to trueboolfalseno
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
preferred_maintenance_windowThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)string"sun:10:30-sun:14:30"no
publicly_accessibleSpecifies 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 addressboolfalseno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Regionstringn/ayes
replication_instance_classThe compute and memory capacity of the replication instance as specified by the replication instance classstring"dms.t2.small"no
security_group_allow_all_egressA convenience that adds to the rules a rule that allows all egress.
If this is false and no egress rules are specified via rules or rule-matrix, then no egress will be allowed.
security_group_create_before_destroySet true to enable terraform create_before_destroy behavior on the created security group.
We only recommend setting this false if you are importing an existing security group
that you do not want replaced and therefore need full control over its name.
Note that changing this value will always cause the security group to be replaced.
security_group_ingress_cidr_blocksA list of CIDR blocks for the the cluster Security Group to allow ingress to the cluster security group.list(string)[]no
security_group_ingress_from_portStart port on which the Glue connection accepts incoming connections.number0no
security_group_ingress_to_portEnd port on which the Glue connection accepts incoming connections.number65535no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


dms_replication_instance_arnDMS replication instance ARN
dms_replication_instance_idDMS replication instance ID