DMS Endpoint

An AWS DMS Endpoint defines a connection to a source or target data store for Database Migration Service. It contains the connection details such as database engine type, server name, port, and authentication information. Endpoints are used by DMS tasks to read from the source and write to the target, enabling migrations, replications, or continuous data synchronization between different databases or storage systems.

aws.dms_endpoint

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
aws_external_idcorestringValue returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
certificate_arncorestringThe Amazon Resource Name (ARN) used for SSL connection to the endpoint.
database_namecorestringThe name of the database at the endpoint.
dms_transfer_settingscorejsonThe settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
doc_db_settingscorejsonProvides information that defines a DocumentDB endpoint.
dynamo_db_settingscorejsonThe settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
elasticsearch_settingscorejsonThe settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.
endpoint_arncorestringThe Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
endpoint_identifiercorestringThe database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
endpoint_typecorestringThe type of endpoint. Valid values are source and target.
engine_display_namecorestringThe expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".
engine_namecorestringThe database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".
external_table_definitioncorestringThe external table definition.
extra_connection_attributescorestringAdditional connection attributes used to connect to the endpoint.
gcp_my_sql_settingscorejsonSettings in JSON format for the source GCP MySQL endpoint.
ibm_db2_settingscorejsonThe settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
kafka_settingscorejsonThe settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
kinesis_settingscorejsonThe settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
kms_key_idcorestringAn KMS key identifier that is used to encrypt the connection parameters for the endpoint. 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.
microsoft_sql_server_settingscorejsonThe settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
mongo_db_settingscorejsonThe settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
my_sql_settingscorejsonThe settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
neptune_settingscorejsonThe settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
oracle_settingscorejsonThe settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
portcoreint64The port value used to access the endpoint.
postgre_sql_settingscorejsonThe settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
redis_settingscorejsonThe settings for the Redis target endpoint. For more information, see the RedisSettings structure.
redshift_settingscorejsonSettings for the Amazon Redshift endpoint.
s3_settingscorejsonThe settings for the S3 target endpoint. For more information, see the S3Settings structure.
server_namecorestringThe name of the server at the endpoint.
service_access_role_arncorestringThe Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
ssl_modecorestringThe SSL mode used to connect to the endpoint. The default value is none.
statuscorestringThe status of the endpoint.
sybase_settingscorejsonThe settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
tagscorehstore
timestream_settingscorejsonThe settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.
usernamecorestringThe user name used to connect to the endpoint.