Module library

DMS

Terraform module to create AWS DMS (Database Migration Service) resources

Version

Inputs

40 / 53
access_iam_role_descriptionoptionalstring

Description of the role

Defaultnull
access_iam_role_nameoptionalstring

Name to use on IAM role created

Defaultnull
access_iam_role_pathoptionalstring

IAM role path

Defaultnull
access_iam_role_permissions_boundaryoptionalstring

ARN of the policy that is used to set the permissions boundary for the IAM role

Defaultnull
access_iam_role_policiesoptionalmap(string)

Map of IAM role policy ARNs to attach to the IAM role

Default{}
access_iam_role_tagsoptionalmap(string)

A map of additional tags to add to the IAM role created

Default{}
access_iam_role_use_name_prefixoptionalbool

Determines whether the IAM role name (`access_iam_role_name`) is used as a prefix

Defaulttrue
access_iam_statementsoptionalany

A map of IAM policy [statements](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document#statement) for custom permission usage

Default{}
access_kms_key_arnsoptionallist(string)

A list of KMS key ARNs the access IAM role is permitted to decrypt

Default[]
access_secret_arnsoptionallist(string)

A list of SecretManager secret ARNs the access IAM role is permitted to access

Default[]
access_source_s3_bucket_arnsoptionallist(string)

A list of S3 bucket ARNs the access IAM role is permitted to access

Default[]
access_target_dynamodb_table_arnsoptionallist(string)

A list of DynamoDB table ARNs the access IAM role is permitted to access

Default[]
access_target_elasticsearch_arnsoptionallist(string)

A list of Elasticsearch ARNs the access IAM role is permitted to access

Default[]
access_target_kinesis_arnsoptionallist(string)

A list of Kinesis ARNs the access IAM role is permitted to access

Default[]
access_target_s3_bucket_arnsoptionallist(string)

A list of S3 bucket ARNs the access IAM role is permitted to access

Default[]
certificatesoptionalmap(any)

Map of objects that define the certificates to be created

Default{}
createoptionalbool

Determines whether resources will be created

Defaulttrue
create_access_iam_roleoptionalbool

Determines whether the ECS task definition IAM role should be created

Defaulttrue
create_access_policyoptionalbool

Determines whether the IAM policy should be created

Defaulttrue
create_iam_rolesoptionalbool

Determines whether the required [DMS IAM resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole) will be created

Defaulttrue
create_repl_instanceoptionalbool

Indicates whether a replication instace should be created

Defaulttrue
create_repl_subnet_groupoptionalbool

Determines whether the replication subnet group will be created

Defaulttrue
enable_redshift_target_permissionsoptionalbool

Determines whether `redshift.amazonaws.com` is permitted access to assume the `dms-access-for-endpoint` role

Defaultfalse
endpointsoptionalany

Map of objects that define the endpoints to be created

Default{}
event_subscription_timeoutsoptionalmap(string)

A map of timeouts for event subscription create/update/delete operations

Default{}
event_subscriptionsoptionalany

Map of objects that define the event subscriptions to be created

Default{}
iam_role_permissions_boundaryoptionalstring

ARN of the policy that is used to set the permissions boundary for the role

Defaultnull
iam_role_tagsoptionalmap(string)

A map of additional tags to apply to the DMS IAM roles

Default{}
repl_config_timeoutsoptionalmap(string)

A map of timeouts for serverless replication config create/update/delete operations

Default{}
repl_instance_allocated_storageoptionalnumber

The amount of storage (in gigabytes) to be initially allocated for the replication instance. Min: 5, Max: 6144, Default: 50

Defaultnull
repl_instance_allow_major_version_upgradeoptionalbool

Indicates that major version upgrades are allowed

Defaulttrue
repl_instance_apply_immediatelyoptionalbool

Indicates whether the changes should be applied immediately or during the next maintenance window

Defaultnull
repl_instance_auto_minor_version_upgradeoptionalbool

Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window

Defaulttrue
repl_instance_availability_zoneoptionalstring

The EC2 Availability Zone that the replication instance will be created in

Defaultnull
repl_instance_classoptionalstring

The compute and memory capacity of the replication instance as specified by the replication instance class

Defaultnull
repl_instance_engine_versionoptionalstring

The [engine version](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReleaseNotes.html) number of the replication instance

Defaultnull
repl_instance_idoptionalstring

The replication instance identifier. This parameter is stored as a lowercase string

Defaultnull
repl_instance_kms_key_arnoptionalstring

The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters

Defaultnull
repl_instance_multi_azoptionalbool

Specifies if the replication instance is a multi-az deployment. You cannot set the `availability_zone` parameter if the `multi_az` parameter is set to `true`

Defaultnull
repl_instance_network_typeoptionalstring

The type of IP address protocol used by a replication instance. Valid values: IPV4, DUAL

Defaultnull

All 53 are optional — the module deploys with none of them set. Showing 40, so the site stays a static download — the remaining 13 are in the source.

Outputs

23
access_iam_role_arn

Access IAM role ARN

access_iam_role_name

Access IAM role name

access_iam_role_unique_id

Stable and unique string identifying the access IAM role

certificates

A map of maps containing the certificates created and their full output of attributes and values

dms_access_for_endpoint_iam_role_arn

Amazon Resource Name (ARN) specifying the role

dms_access_for_endpoint_iam_role_id

Name of the IAM role

dms_access_for_endpoint_iam_role_unique_id

Stable and unique string identifying the role

dms_cloudwatch_logs_iam_role_arn

Amazon Resource Name (ARN) specifying the role

dms_cloudwatch_logs_iam_role_id

Name of the IAM role

dms_cloudwatch_logs_iam_role_unique_id

Stable and unique string identifying the role

dms_vpc_iam_role_arn

Amazon Resource Name (ARN) specifying the role

dms_vpc_iam_role_id

Name of the IAM role

dms_vpc_iam_role_unique_id

Stable and unique string identifying the role

endpoints

A map of maps containing the endpoints created and their full output of attributes and values

event_subscriptions

A map of maps containing the event subscriptions created and their full output of attributes and values

replication_instance_arn

The Amazon Resource Name (ARN) of the replication instance

replication_instance_private_ips

A list of the private IP addresses of the replication instance

replication_instance_public_ips

A list of the public IP addresses of the replication instance

replication_instance_tags_all

A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block

replication_subnet_group_id

The ID of the subnet group

replication_tasks

A map of maps containing the replication tasks created and their full output of attributes and values

s3_endpoints

A map of maps containing the S3 endpoints created and their full output of attributes and values

serverless_replication_tasks

A map of maps containing the serverless replication tasks (replication_config) created and their full output of attributes and values

What the agent wires into the next module. An edge on the architecture diagram is one of these consumed by something else.