v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1469325456.8 KB

Creates an endpoint using the provided settings.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

post/#X-Amz-Target=AmazonDMSv20160101.CreateEndpoint

Headers

X-Amz-Target'AmazonDMSv20160101.CreateEndpoint' required

Request body

EndpointIdentifierstring required

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.

EndpointType'source' | 'target' required

The type of endpoint. Valid values are <code>source</code> and <code>target</code>.

EngineNamestring required

The type of engine for the endpoint. Valid values, depending on the <code>EndpointType</code> value, include <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>, <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"opensearch"</code>, <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"db2-zos"</code>, <code>"azuredb"</code>, <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>, <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>, <code>"docdb"</code>, <code>"sqlserver"</code>, <code>"neptune"</code>, and <code>"babelfish"</code>.

Usernamestring

The user name to be used to log in to the endpoint database.

Passwordstring password

The password to be used to log in to the endpoint database.

ServerNamestring

The name of the server where the endpoint database resides.

Portinteger

The port used by the endpoint database.

DatabaseNamestring

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and <code>targetDbType</code>.

ExtraConnectionAttributesstring

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 <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html">Working with DMS Endpoints</a> in the <i>Database Migration Service User Guide.</i>

KmsKeyIdstring
<p>An KMS key identifier that is used to encrypt the connection parameters for the endpoint.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>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.</p>
CertificateArnstring

The Amazon Resource Name (ARN) for the certificate.

SslMode'none' | 'require' | 'verify-ca' | 'verify-full'

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is <code>none</code>

ServiceAccessRoleArnstring

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the <code>iam:PassRole</code> action.

ExternalTableDefinitionstring

The external table definition.

ResourceIdentifierstring

A friendly name for the resource identifier at the end of the <code>EndpointArn</code> response parameter that is returned in the created <code>Endpoint</code> 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 <code>Example-App-ARN1</code>. For example, this value might result in the <code>EndpointArn</code> value <code>arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1</code>. If you don't specify a <code>ResourceIdentifier</code> value, DMS generates a default identifier value for the end of <code>EndpointArn</code>.

Response

Success

Example response

{
  "Endpoint": {
    "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
    "EndpointIdentifier": "test-endpoint-1",
    "EndpointType": "source",
    "EngineName": "mysql",
    "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
    "Port": 3306,
    "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
    "Status": "active",
    "Username": "username"
  }
}