This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).
# AWS::DMS::Endpoint
The `AWS::DMS::Endpoint` resource specifies an AWS DMS endpoint.
Currently, AWS CloudFormation supports all AWS DMS endpoint types.
## Syntax
To declare this entity in your CloudFormation template, use the following syntax:
### JSON
```
{
"Type" : "AWS::DMS::Endpoint",
"Properties" : {
"[CertificateArn](#cfn-dms-endpoint-certificatearn)" : String,
"[DatabaseName](#cfn-dms-endpoint-databasename)" : String,
"[DocDbSettings](#cfn-dms-endpoint-docdbsettings)" : DocDbSettings,
"[DynamoDbSettings](#cfn-dms-endpoint-dynamodbsettings)" : DynamoDbSettings,
"[ElasticsearchSettings](#cfn-dms-endpoint-elasticsearchsettings)" : ElasticsearchSettings,
"[EndpointIdentifier](#cfn-dms-endpoint-endpointidentifier)" : String,
"[EndpointType](#cfn-dms-endpoint-endpointtype)" : String,
"[EngineName](#cfn-dms-endpoint-enginename)" : String,
"[ExtraConnectionAttributes](#cfn-dms-endpoint-extraconnectionattributes)" : String,
"[GcpMySQLSettings](#cfn-dms-endpoint-gcpmysqlsettings)" : GcpMySQLSettings,
"[IbmDb2Settings](#cfn-dms-endpoint-ibmdb2settings)" : IbmDb2Settings,
"[KafkaSettings](#cfn-dms-endpoint-kafkasettings)" : KafkaSettings,
"[KinesisSettings](#cfn-dms-endpoint-kinesissettings)" : KinesisSettings,
"[KmsKeyId](#cfn-dms-endpoint-kmskeyid)" : String,
"[MicrosoftSqlServerSettings](#cfn-dms-endpoint-microsoftsqlserversettings)" : MicrosoftSqlServerSettings,
"[MongoDbSettings](#cfn-dms-endpoint-mongodbsettings)" : MongoDbSettings,
"[MySqlSettings](#cfn-dms-endpoint-mysqlsettings)" : MySqlSettings,
"[NeptuneSettings](#cfn-dms-endpoint-neptunesettings)" : NeptuneSettings,
"[OracleSettings](#cfn-dms-endpoint-oraclesettings)" : OracleSettings,
"[Password](#cfn-dms-endpoint-password)" : String,
"[Port](#cfn-dms-endpoint-port)" : Integer,
"[PostgreSqlSettings](#cfn-dms-endpoint-postgresqlsettings)" : PostgreSqlSettings,
"[RedisSettings](#cfn-dms-endpoint-redissettings)" : RedisSettings,
"[RedshiftSettings](#cfn-dms-endpoint-redshiftsettings)" : RedshiftSettings,
"[ResourceIdentifier](#cfn-dms-endpoint-resourceidentifier)" : String,
"[S3Settings](#cfn-dms-endpoint-s3settings)" : S3Settings,
"[ServerName](#cfn-dms-endpoint-servername)" : String,
"[SslMode](#cfn-dms-endpoint-sslmode)" : String,
"[SybaseSettings](#cfn-dms-endpoint-sybasesettings)" : SybaseSettings,
"[Tags](#cfn-dms-endpoint-tags)" : [ Tag, ... ],
"[Username](#cfn-dms-endpoint-username)" : String
}
}
```
### YAML
```
Type: AWS::DMS::Endpoint
Properties:
[CertificateArn](#cfn-dms-endpoint-certificatearn): String
[DatabaseName](#cfn-dms-endpoint-databasename): String
[DocDbSettings](#cfn-dms-endpoint-docdbsettings):
DocDbSettings
[DynamoDbSettings](#cfn-dms-endpoint-dynamodbsettings):
DynamoDbSettings
[ElasticsearchSettings](#cfn-dms-endpoint-elasticsearchsettings):
ElasticsearchSettings
[EndpointIdentifier](#cfn-dms-endpoint-endpointidentifier): String
[EndpointType](#cfn-dms-endpoint-endpointtype): String
[EngineName](#cfn-dms-endpoint-enginename): String
[ExtraConnectionAttributes](#cfn-dms-endpoint-extraconnectionattributes): String
[GcpMySQLSettings](#cfn-dms-endpoint-gcpmysqlsettings):
GcpMySQLSettings
[IbmDb2Settings](#cfn-dms-endpoint-ibmdb2settings):
IbmDb2Settings
[KafkaSettings](#cfn-dms-endpoint-kafkasettings):
KafkaSettings
[KinesisSettings](#cfn-dms-endpoint-kinesissettings):
KinesisSettings
[KmsKeyId](#cfn-dms-endpoint-kmskeyid): String
[MicrosoftSqlServerSettings](#cfn-dms-endpoint-microsoftsqlserversettings):
MicrosoftSqlServerSettings
[MongoDbSettings](#cfn-dms-endpoint-mongodbsettings):
MongoDbSettings
[MySqlSettings](#cfn-dms-endpoint-mysqlsettings):
MySqlSettings
[NeptuneSettings](#cfn-dms-endpoint-neptunesettings):
NeptuneSettings
[OracleSettings](#cfn-dms-endpoint-oraclesettings):
OracleSettings
[Password](#cfn-dms-endpoint-password): String
[Port](#cfn-dms-endpoint-port): Integer
[PostgreSqlSettings](#cfn-dms-endpoint-postgresqlsettings):
PostgreSqlSettings
[RedisSettings](#cfn-dms-endpoint-redissettings):
RedisSettings
[RedshiftSettings](#cfn-dms-endpoint-redshiftsettings):
RedshiftSettings
[ResourceIdentifier](#cfn-dms-endpoint-resourceidentifier): String
[S3Settings](#cfn-dms-endpoint-s3settings):
S3Settings
[ServerName](#cfn-dms-endpoint-servername): String
[SslMode](#cfn-dms-endpoint-sslmode): String
[SybaseSettings](#cfn-dms-endpoint-sybasesettings):
SybaseSettings
[Tags](#cfn-dms-endpoint-tags):
- Tag
[Username](#cfn-dms-endpoint-username): String
```
## Properties
`CertificateArn`
The Amazon Resource Name (ARN) for the certificate.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`DatabaseName`
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`.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`DocDbSettings`
Settings in JSON format for the source and target DocumentDB endpoint. For more information about other available settings, see [ Using extra connections attributes with Amazon DocumentDB as a source](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [ Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [DocDbSettings](aws-properties-dms-endpoint-docdbsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`DynamoDbSettings`
Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see [ Using object mapping to migrate data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [DynamoDbSettings](aws-properties-dms-endpoint-dynamodbsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ElasticsearchSettings`
Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see [ Extra connection attributes when using OpenSearch as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [ElasticsearchSettings](aws-properties-dms-endpoint-elasticsearchsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`EndpointIdentifier`
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.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`EndpointType`
The type of endpoint. Valid values are `source` and `target`.
*Required*: Yes
*Type*: String
*Allowed values*: `source | target`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`EngineName`
The type of engine for the endpoint, depending on the `EndpointType` value.
*Valid values*: `mysql` \$1 `oracle` \$1 `postgres` \$1 `mariadb` \$1 `aurora` \$1 `aurora-postgresql` \$1 `opensearch` \$1 `redshift` \$1 `redshift-serverless` \$1`s3` \$1 `db2` \$1 `azuredb` \$1 `sybase` \$1 `dynamodb` \$1 `mongodb` \$1 `kinesis` \$1 `kafka` \$1 `elasticsearch` \$1 `docdb` \$1 `sqlserver` \$1 `neptune`
*Required*: Yes
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ExtraConnectionAttributes`
Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see [ Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`GcpMySQLSettings`
Settings in JSON format for the source GCP MySQL endpoint. These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see [ Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [GcpMySQLSettings](aws-properties-dms-endpoint-gcpmysqlsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`IbmDb2Settings`
Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see [ Extra connection attributes when using Db2 LUW as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [IbmDb2Settings](aws-properties-dms-endpoint-ibmdb2settings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`KafkaSettings`
Settings in JSON format for the target Apache Kafka endpoint. For more information about other available settings, see [ Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [KafkaSettings](aws-properties-dms-endpoint-kafkasettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`KinesisSettings`
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about other available settings, see [ Using object mapping to migrate data to a Kinesis data stream](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [KinesisSettings](aws-properties-dms-endpoint-kinesissettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`KmsKeyId`
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.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*Required*: No
*Type*: String
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`MicrosoftSqlServerSettings`
Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see [ Extra connection attributes when using SQL Server as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [ Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [MicrosoftSqlServerSettings](aws-properties-dms-endpoint-microsoftsqlserversettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`MongoDbSettings`
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see [ Using MongoDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [MongoDbSettings](aws-properties-dms-endpoint-mongodbsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`MySqlSettings`
Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see [Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide.*
*Required*: No
*Type*: [MySqlSettings](aws-properties-dms-endpoint-mysqlsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`NeptuneSettings`
Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see [ Specifying endpoint settings for Amazon Neptune as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [NeptuneSettings](aws-properties-dms-endpoint-neptunesettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`OracleSettings`
Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see [ Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [ Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [OracleSettings](aws-properties-dms-endpoint-oraclesettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Password`
The password to be used to log in to the endpoint database.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Port`
The port used by the endpoint database.
*Required*: No
*Type*: Integer
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`PostgreSqlSettings`
Settings in JSON format for the source and target PostgreSQL endpoint.
For information about other available settings, see [ Extra connection attributes when using PostgreSQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) and [ Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [PostgreSqlSettings](aws-properties-dms-endpoint-postgresqlsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`RedisSettings`
Settings in JSON format for the target Redis endpoint. For information about other available settings, see [ Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [RedisSettings](aws-properties-dms-endpoint-redissettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`RedshiftSettings`
Settings in JSON format for the Amazon Redshift endpoint.
For more information about other available settings, see [ Extra connection attributes when using Amazon Redshift as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [RedshiftSettings](aws-properties-dms-endpoint-redshiftsettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ResourceIdentifier`
A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`.
For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`.
*Required*: No
*Type*: String
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`S3Settings`
Settings in JSON format for the source and target Amazon S3 endpoint. For more information about other available settings, see [ Extra connection attributes when using Amazon S3 as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [ Extra connection attributes when using Amazon S3 as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the*AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [S3Settings](aws-properties-dms-endpoint-s3settings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ServerName`
The name of the server where the endpoint database resides.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`SslMode`
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is `none`.
When `engine_name` is set to S3, the only allowed value is `none`.
*Required*: No
*Type*: String
*Allowed values*: `none | require | verify-ca | verify-full`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`SybaseSettings`
Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see [ Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [ Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the *AWS Database Migration Service User Guide*.
*Required*: No
*Type*: [SybaseSettings](aws-properties-dms-endpoint-sybasesettings.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Tags`
One or more tags to be assigned to the endpoint.
*Required*: No
*Type*: Array of [Tag](aws-properties-dms-endpoint-tag.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Username`
The user name to be used to log in to the endpoint database.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
## Return values
### Ref
When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the endpoint.
For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).
### Fn::GetAtt
The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).
####
`ExternalId`
A value that can be used for cross-account validation.
## Examples
###
#### JSON
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Resources": {
"myBasicEndpoint": {
"Type": "AWS::DMS::Endpoint",
"Properties": {
"EngineName": "mysql",
"EndpointType": "source",
"Username": "username",
"Password": {
"Ref": "PasswordParameter"
},
"ServerName": "source.db.amazon.com",
"Port": 1234,
"DatabaseName": "source-db"
}
}
}
}
```
#### YAML
```
AWSTemplateFormatVersion: 2010-09-09
Description: "Endpoint test"
Resources:
BasicEndpoint:
Type: AWS::DMS::Endpoint
Properties:
DatabaseName: my-db
EndpointType: target
EngineName: mysql
Password: PasswordParameter
Port: 1234
ServerName: server.db.amazon.com
Tags:
- Key: type
Value: new
Username: username
```
## See also
+ [ CreateEndpoint](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateEndpoint.html) in the *AWS Database Migration Service API Reference*
+ [Managing AWS resources as a single unit with AWS CloudFormation stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html)