---
type: resource-type
title: DMSEndpoint
description: aws resource type AWS::DMS::Endpoint
name: DMSEndpoint
lexicon: aws
resource_type: AWS::DMS::Endpoint
---
`AWS::DMS::Endpoint`, a resource type of the aws lexicon.

## Properties

- `EndpointType` (`string`, required): The type of endpoint. Valid values are source and target.
- `EngineName` (`string`, required): The type of engine for the endpoint, depending on the EndpointType value.
- `CertificateArn` (`string`, optional): The Amazon Resource Name (ARN) for the certificate.
- `DatabaseName` (`string`, optional): The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
- `DocDbSettings` (`DMSEndpoint_DocDbSettings`, optional): Settings in JSON format for the source and target DocumentDB endpoint
- `DynamoDbSettings` (`DMSEndpoint_DynamoDbSettings`, optional): Settings in JSON format for the target Amazon DynamoDB endpoint
- `ElasticsearchSettings` (`DMSEndpoint_ElasticsearchSettings`, optional): Settings in JSON format for the target OpenSearch endpoint
- `EndpointArn` (`string`, optional): The endpoint ARN.
- `EndpointIdentifier` (`string`, optional): The 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.
- `ExternalId` (`string`, optional): A value that can be used for cross-account validation.
- `ExtraConnectionAttributes` (`string`, optional): Additional attributes associated with the connection
- `GcpMySQLSettings` (`DMSEndpoint_GcpMySQLSettings`, optional): Settings in JSON format for the source GCP MySQL endpoint
- `IbmDb2Settings` (`DMSEndpoint_IbmDb2Settings`, optional): Settings in JSON format for the source IBM Db2 LUW endpoint
- `KafkaSettings` (`DMSEndpoint_KafkaSettings`, optional): Settings in JSON format for the target Apache Kafka endpoint
- `KinesisSettings` (`DMSEndpoint_KinesisSettings`, optional): Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
- `KmsKeyId` (`string`, optional): An AWS 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, AWS DMS uses your default encryption key.
- `MicrosoftSqlServerSettings` (`DMSEndpoint_MicrosoftSqlServerSettings`, optional): Settings in JSON format for the source and target Microsoft SQL Server endpoint
- `MongoDbSettings` (`DMSEndpoint_MongoDbSettings`, optional): Settings in JSON format for the source MongoDB endpoint
- `MySqlSettings` (`DMSEndpoint_MySqlSettings`, optional): Settings in JSON format for the source and target MySQL endpoin
- `NeptuneSettings` (`DMSEndpoint_NeptuneSettings`, optional): Settings in JSON format for the target Amazon Neptune endpoint
- `OracleSettings` (`DMSEndpoint_OracleSettings`, optional): Settings in JSON format for the source and target Oracle endpoint
- `Password` (`string`, optional): The password to be used to log in to the endpoint database.
- `Port` (`number`, optional): The port used by the endpoint database.
- `PostgreSqlSettings` (`DMSEndpoint_PostgreSqlSettings`, optional): Settings in JSON format for the source and target PostgreSQL endpoint.
- `RedisSettings` (`DMSEndpoint_RedisSettings`, optional): Settings in JSON format for the target Redis endpoint
- `RedshiftSettings` (`DMSEndpoint_RedshiftSettings`, optional): Settings in JSON format for the Amazon Redshift endpoint.
- `ResourceIdentifier` (`string`, optional): A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
- `S3Settings` (`DMSEndpoint_S3Settings`, optional): Settings in JSON format for the source and target Amazon S3 endpoint
- `ServerName` (`string`, optional): The name of the server where the endpoint database resides.
- `SslMode` (`string`, optional): The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
- `SybaseSettings` (`DMSEndpoint_SybaseSettings`, optional): Settings in JSON format for the source and target SAP ASE endpoint.
- `Tags` (`DMSEndpoint_Tag[]`, optional): One or more tags to be assigned to the endpoint.
- `Username` (`string`, optional): The user name to be used to log in to the endpoint database.

## Attributes

- `EndpointArn`
- `ExternalId`