Skip to main content

Component: dms/endpoint

This component provisions DMS endpoints.


Stack Level: Regional

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

type: abstract
workspace_enabled: true
autodeploy: false
enabled: true

component: dms/endpoint
- dms/endpoint/defaults
name: source-example
endpoint_type: source
engine_name: aurora-postgresql
server_name: ""
database_name: ""
port: 5432
extra_connection_attributes: ""
secrets_manager_access_role_arn: ""
secrets_manager_arn: ""
ssl_mode: none
- source

component: dms/endpoint
- dms/endpoint/defaults
name: target-example
endpoint_type: target
engine_name: s3
extra_connection_attributes: ""
bucket_name: ""
bucket_folder: null
cdc_inserts_only: false
csv_row_delimiter: " "
csv_delimiter: ","
data_format: parquet
compression_type: GZIP
date_partition_delimiter: NONE
date_partition_enabled: true
date_partition_sequence: YYYYMMDD
include_op_for_full_load: true
parquet_timestamp_in_millisecond: true
timestamp_column_name: timestamp
service_access_role_arn: ""
- target


terraform>= 1.0
aws>= 4.26.0


aws>= 4.26.0




aws_ssm_parameter.passworddata source
aws_ssm_parameter.usernamedata source


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.
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.
certificate_arnCertificate ARNstringnullno
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
database_nameName of the endpoint databasestringnullno
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).
elasticsearch_settingsConfiguration block for OpenSearch settingsmap(any)nullno
enabledSet to false to prevent the module from creating any resourcesboolnullno
endpoint_typeType of endpoint. Valid values are source, targetstringn/ayes
engine_nameType of engine for the endpoint. Valid values are aurora, aurora-postgresql, azuredb, db2, docdb, dynamodb, elasticsearch, kafka, kinesis, mariadb, mongodb, mysql, opensearch, oracle, postgres, redshift, s3, sqlserver, sybasestringn/ayes
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
extra_connection_attributesAdditional attributes associated with the connection to the source databasestring""no
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.
kafka_settingsConfiguration block for Kafka settingsmap(any)nullno
kinesis_settingsConfiguration block for Kinesis settingsmap(any)nullno
kms_key_arn(Required when engine_name is mongodb, optional otherwise). ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kms_key_arn, then AWS DMS will use your default encryption keystringnullno
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.
mongodb_settingsConfiguration block for MongoDB settingsmap(any)nullno
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
passwordPassword to be used to login to the endpoint databasestring""no
password_pathIf set, the path in AWS SSM Parameter Store to fetch the password for the DMS admin userstring""no
portPort used by the endpoint databasenumbernullno
redshift_settingsConfiguration block for Redshift settingsmap(any)nullno
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
s3_settingsConfiguration block for S3 settingsmap(any)nullno
secrets_manager_access_role_arnARN of the IAM role that specifies AWS DMS as the trusted entity and has the required permissions to access the value in SecretsManagerSecretstringnullno
secrets_manager_arnFull ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the endpoint connection details. Supported only for engine_name as aurora, aurora-postgresql, mariadb, mongodb, mysql, oracle, postgres, redshift or sqlserverstringnullno
server_nameHost name of the database serverstringnullno
service_access_roleARN used by the service access IAM role for DynamoDB endpointsstringnullno
ssl_modeThe SSL mode to use for the connection. Can be one of none, require, verify-ca, verify-fullstring"none"no
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
usernameUser name to be used to login to the endpoint databasestring""no
username_pathIf set, the path in AWS SSM Parameter Store to fetch the username for the DMS admin userstring""no


dms_endpoint_arnDMS endpoint ARN
dms_endpoint_idDMS endpoint ID