endpoint
This component provisions DMS endpoints.
Usage
Stack Level: Regional
Here are some example snippets for how to use this component:
components:
terraform:
dms/endpoint/defaults:
metadata:
type: abstract
settings:
spacelift:
workspace_enabled: true
autodeploy: false
vars:
enabled: true
dms-endpoint-source-example:
metadata:
component: dms/endpoint
inherits:
- dms/endpoint/defaults
vars:
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
attributes:
- source
dms-endpoint-target-example:
metadata:
component: dms/endpoint
inherits:
- dms/endpoint/defaults
vars:
name: target-example
endpoint_type: target
engine_name: s3
extra_connection_attributes: ""
s3_settings:
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: ""
attributes:
- target
Requirements
Name | Version |
---|---|
terraform | >= 1.0 |
aws | >= 4.26.0 |
Providers
Name | Version |
---|---|
aws | >= 4.26.0 |
Modules
Name | Source | Version |
---|---|---|
dms_endpoint | cloudposse/dms/aws//modules/dms-endpoint | 0.1.1 |
iam_roles | ../../account-map/modules/iam-roles | n/a |
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_ssm_parameter.password | data source |
aws_ssm_parameter.username | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional 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. | map(string) | {} | no |
attributes | ID 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. | list(string) | [] | no |
certificate_arn | Certificate ARN | string | null | no |
context | Single 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. | any | { | no |
database_name | Name of the endpoint database | string | null | no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
descriptor_formats | Describe 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 beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
elasticsearch_settings | Configuration block for OpenSearch settings | map(any) | null | no |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
endpoint_type | Type of endpoint. Valid values are source , target | string | n/a | yes |
engine_name | Type 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 , sybase | string | n/a | yes |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
extra_connection_attributes | Additional attributes associated with the connection to the source database | string | "" | no |
id_length_limit | Limit 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 . | number | null | no |
kafka_settings | Configuration block for Kafka settings | map(any) | null | no |
kinesis_settings | Configuration block for Kinesis settings | map(any) | null | no |
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 key | string | null | no |
label_key_case | Controls 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 . | string | null | no |
label_order | The 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. | list(string) | null | no |
label_value_case | Controls 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 . | string | null | no |
labels_as_tags | Set 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.Notes: 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 bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) | [ | no |
mongodb_settings | Configuration block for MongoDB settings | map(any) | null | no |
name | ID 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. | string | null | no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
password | Password to be used to login to the endpoint database | string | "" | no |
password_path | If set, the path in AWS SSM Parameter Store to fetch the password for the DMS admin user | string | "" | no |
port | Port used by the endpoint database | number | null | no |
redshift_settings | Configuration block for Redshift settings | map(any) | null | no |
regex_replace_chars | Terraform 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. | string | null | no |
region | AWS Region | string | n/a | yes |
s3_settings | Configuration block for S3 settings | map(any) | null | no |
secrets_manager_access_role_arn | ARN of the IAM role that specifies AWS DMS as the trusted entity and has the required permissions to access the value in SecretsManagerSecret | string | null | no |
secrets_manager_arn | Full 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 sqlserver | string | null | no |
server_name | Host name of the database server | string | null | no |
service_access_role | ARN used by the service access IAM role for DynamoDB endpoints | string | null | no |
ssl_mode | The SSL mode to use for the connection. Can be one of none , require , verify-ca , verify-full | string | "none" | no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
username | User name to be used to login to the endpoint database | string | "" | no |
username_path | If set, the path in AWS SSM Parameter Store to fetch the username for the DMS admin user | string | "" | no |
Outputs
Name | Description |
---|---|
dms_endpoint_arn | DMS endpoint ARN |
dms_endpoint_id | DMS endpoint ID |
References
- cloudposse/terraform-aws-components - Cloud Posse's upstream component