CreateEndpoint - AWS Database Migration Service
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also

CreateEndpoint

Creates an endpoint using the provided settings.

Note

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 AWS DMS task.

Request Syntax

{
   "CertificateArn": "string",
   "DatabaseName": "string",
   "DmsTransferSettings": { 
      "BucketName": "string",
      "ServiceAccessRoleArn": "string"
   },
   "DocDbSettings": { 
      "DatabaseName": "string",
      "DocsToInvestigate": number,
      "ExtractDocId": boolean,
      "KmsKeyId": "string",
      "NestingLevel": "string",
      "Password": "string",
      "Port": number,
      "ReplicateShardCollections": boolean,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "Username": "string",
      "UseUpdateLookUp": boolean
   },
   "DynamoDbSettings": { 
      "ServiceAccessRoleArn": "string"
   },
   "ElasticsearchSettings": { 
      "EndpointUri": "string",
      "ErrorRetryDuration": number,
      "FullLoadErrorPercentage": number,
      "ServiceAccessRoleArn": "string",
      "UseNewMappingType": boolean
   },
   "EndpointIdentifier": "string",
   "EndpointType": "string",
   "EngineName": "string",
   "ExternalTableDefinition": "string",
   "ExtraConnectionAttributes": "string",
   "GcpMySQLSettings": { 
      "AfterConnectScript": "string",
      "CleanSourceMetadataOnMismatch": boolean,
      "DatabaseName": "string",
      "EventsPollInterval": number,
      "MaxFileSize": number,
      "ParallelLoadThreads": number,
      "Password": "string",
      "Port": number,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "ServerTimezone": "string",
      "TargetDbType": "string",
      "Username": "string"
   },
   "IBMDb2Settings": { 
      "CurrentLsn": "string",
      "DatabaseName": "string",
      "KeepCsvFiles": boolean,
      "LoadTimeout": number,
      "MaxFileSize": number,
      "MaxKBytesPerRead": number,
      "Password": "string",
      "Port": number,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "SetDataCaptureChanges": boolean,
      "Username": "string",
      "WriteBufferSize": number
   },
   "KafkaSettings": { 
      "Broker": "string",
      "IncludeControlDetails": boolean,
      "IncludeNullAndEmpty": boolean,
      "IncludePartitionValue": boolean,
      "IncludeTableAlterOperations": boolean,
      "IncludeTransactionDetails": boolean,
      "MessageFormat": "string",
      "MessageMaxBytes": number,
      "NoHexPrefix": boolean,
      "PartitionIncludeSchemaTable": boolean,
      "SaslMechanism": "string",
      "SaslPassword": "string",
      "SaslUsername": "string",
      "SecurityProtocol": "string",
      "SslCaCertificateArn": "string",
      "SslClientCertificateArn": "string",
      "SslClientKeyArn": "string",
      "SslClientKeyPassword": "string",
      "SslEndpointIdentificationAlgorithm": "string",
      "Topic": "string",
      "UseLargeIntegerValue": boolean
   },
   "KinesisSettings": { 
      "IncludeControlDetails": boolean,
      "IncludeNullAndEmpty": boolean,
      "IncludePartitionValue": boolean,
      "IncludeTableAlterOperations": boolean,
      "IncludeTransactionDetails": boolean,
      "MessageFormat": "string",
      "NoHexPrefix": boolean,
      "PartitionIncludeSchemaTable": boolean,
      "ServiceAccessRoleArn": "string",
      "StreamArn": "string",
      "UseLargeIntegerValue": boolean
   },
   "KmsKeyId": "string",
   "MicrosoftSQLServerSettings": { 
      "AuthenticationMethod": "string",
      "BcpPacketSize": number,
      "ControlTablesFileGroup": "string",
      "DatabaseName": "string",
      "ForceLobLookup": boolean,
      "Password": "string",
      "Port": number,
      "QuerySingleAlwaysOnNode": boolean,
      "ReadBackupOnly": boolean,
      "SafeguardPolicy": "string",
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "TlogAccessMode": "string",
      "TrimSpaceInChar": boolean,
      "UseBcpFullLoad": boolean,
      "Username": "string",
      "UseThirdPartyBackupDevice": boolean
   },
   "MongoDbSettings": { 
      "AuthMechanism": "string",
      "AuthSource": "string",
      "AuthType": "string",
      "DatabaseName": "string",
      "DocsToInvestigate": "string",
      "ExtractDocId": "string",
      "KmsKeyId": "string",
      "NestingLevel": "string",
      "Password": "string",
      "Port": number,
      "ReplicateShardCollections": boolean,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "Username": "string",
      "UseUpdateLookUp": boolean
   },
   "MySQLSettings": { 
      "AfterConnectScript": "string",
      "AuthenticationMethod": "string",
      "CleanSourceMetadataOnMismatch": boolean,
      "DatabaseName": "string",
      "EventsPollInterval": number,
      "ExecuteTimeout": number,
      "MaxFileSize": number,
      "ParallelLoadThreads": number,
      "Password": "string",
      "Port": number,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "ServerTimezone": "string",
      "ServiceAccessRoleArn": "string",
      "TargetDbType": "string",
      "Username": "string"
   },
   "NeptuneSettings": { 
      "ErrorRetryDuration": number,
      "IamAuthEnabled": boolean,
      "MaxFileSize": number,
      "MaxRetryCount": number,
      "S3BucketFolder": "string",
      "S3BucketName": "string",
      "ServiceAccessRoleArn": "string"
   },
   "OracleSettings": { 
      "AccessAlternateDirectly": boolean,
      "AdditionalArchivedLogDestId": number,
      "AddSupplementalLogging": boolean,
      "AllowSelectNestedTables": boolean,
      "ArchivedLogDestId": number,
      "ArchivedLogsOnly": boolean,
      "AsmPassword": "string",
      "AsmServer": "string",
      "AsmUser": "string",
      "AuthenticationMethod": "string",
      "CharLengthSemantics": "string",
      "ConvertTimestampWithZoneToUTC": boolean,
      "DatabaseName": "string",
      "DirectPathNoLog": boolean,
      "DirectPathParallelLoad": boolean,
      "EnableHomogenousTablespace": boolean,
      "ExtraArchivedLogDestIds": [ number ],
      "FailTasksOnLobTruncation": boolean,
      "NumberDatatypeScale": number,
      "OpenTransactionWindow": number,
      "OraclePathPrefix": "string",
      "ParallelAsmReadThreads": number,
      "Password": "string",
      "Port": number,
      "ReadAheadBlocks": number,
      "ReadTableSpaceName": boolean,
      "ReplacePathPrefix": boolean,
      "RetryInterval": number,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerOracleAsmAccessRoleArn": "string",
      "SecretsManagerOracleAsmSecretId": "string",
      "SecretsManagerSecretId": "string",
      "SecurityDbEncryption": "string",
      "SecurityDbEncryptionName": "string",
      "ServerName": "string",
      "SpatialDataOptionToGeoJsonFunctionName": "string",
      "StandbyDelayTime": number,
      "TrimSpaceInChar": boolean,
      "UseAlternateFolderForOnline": boolean,
      "UseBFile": boolean,
      "UseDirectPathFullLoad": boolean,
      "UseLogminerReader": boolean,
      "UsePathPrefix": "string",
      "Username": "string"
   },
   "Password": "string",
   "Port": number,
   "PostgreSQLSettings": { 
      "AfterConnectScript": "string",
      "AuthenticationMethod": "string",
      "BabelfishDatabaseName": "string",
      "CaptureDdls": boolean,
      "DatabaseMode": "string",
      "DatabaseName": "string",
      "DdlArtifactsSchema": "string",
      "DisableUnicodeSourceFilter": boolean,
      "ExecuteTimeout": number,
      "FailTasksOnLobTruncation": boolean,
      "HeartbeatEnable": boolean,
      "HeartbeatFrequency": number,
      "HeartbeatSchema": "string",
      "MapBooleanAsBoolean": boolean,
      "MapJsonbAsClob": boolean,
      "MapLongVarcharAs": "string",
      "MaxFileSize": number,
      "Password": "string",
      "PluginName": "string",
      "Port": number,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "ServiceAccessRoleArn": "string",
      "SlotName": "string",
      "TrimSpaceInChar": boolean,
      "Username": "string"
   },
   "RedisSettings": { 
      "AuthPassword": "string",
      "AuthType": "string",
      "AuthUserName": "string",
      "Port": number,
      "ServerName": "string",
      "SslCaCertificateArn": "string",
      "SslSecurityProtocol": "string"
   },
   "RedshiftSettings": { 
      "AcceptAnyDate": boolean,
      "AfterConnectScript": "string",
      "BucketFolder": "string",
      "BucketName": "string",
      "CaseSensitiveNames": boolean,
      "CompUpdate": boolean,
      "ConnectionTimeout": number,
      "DatabaseName": "string",
      "DateFormat": "string",
      "EmptyAsNull": boolean,
      "EncryptionMode": "string",
      "ExplicitIds": boolean,
      "FileTransferUploadStreams": number,
      "LoadTimeout": number,
      "MapBooleanAsBoolean": boolean,
      "MaxFileSize": number,
      "Password": "string",
      "Port": number,
      "RemoveQuotes": boolean,
      "ReplaceChars": "string",
      "ReplaceInvalidChars": "string",
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "ServerSideEncryptionKmsKeyId": "string",
      "ServiceAccessRoleArn": "string",
      "TimeFormat": "string",
      "TrimBlanks": boolean,
      "TruncateColumns": boolean,
      "Username": "string",
      "WriteBufferSize": number
   },
   "ResourceIdentifier": "string",
   "S3Settings": { 
      "AddColumnName": boolean,
      "AddTrailingPaddingCharacter": boolean,
      "BucketFolder": "string",
      "BucketName": "string",
      "CannedAclForObjects": "string",
      "CdcInsertsAndUpdates": boolean,
      "CdcInsertsOnly": boolean,
      "CdcMaxBatchInterval": number,
      "CdcMinFileSize": number,
      "CdcPath": "string",
      "CompressionType": "string",
      "CsvDelimiter": "string",
      "CsvNoSupValue": "string",
      "CsvNullValue": "string",
      "CsvRowDelimiter": "string",
      "DataFormat": "string",
      "DataPageSize": number,
      "DatePartitionDelimiter": "string",
      "DatePartitionEnabled": boolean,
      "DatePartitionSequence": "string",
      "DatePartitionTimezone": "string",
      "DictPageSizeLimit": number,
      "EnableStatistics": boolean,
      "EncodingType": "string",
      "EncryptionMode": "string",
      "ExpectedBucketOwner": "string",
      "ExternalTableDefinition": "string",
      "GlueCatalogGeneration": boolean,
      "IgnoreHeaderRows": number,
      "IncludeOpForFullLoad": boolean,
      "MaxFileSize": number,
      "ParquetTimestampInMillisecond": boolean,
      "ParquetVersion": "string",
      "PreserveTransactions": boolean,
      "Rfc4180": boolean,
      "RowGroupLength": number,
      "ServerSideEncryptionKmsKeyId": "string",
      "ServiceAccessRoleArn": "string",
      "TimestampColumnName": "string",
      "UseCsvNoSupValue": boolean,
      "UseTaskStartTimeForFullLoadTimestamp": boolean
   },
   "ServerName": "string",
   "ServiceAccessRoleArn": "string",
   "SslMode": "string",
   "SybaseSettings": { 
      "DatabaseName": "string",
      "Password": "string",
      "Port": number,
      "SecretsManagerAccessRoleArn": "string",
      "SecretsManagerSecretId": "string",
      "ServerName": "string",
      "Username": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "ResourceArn": "string",
         "Value": "string"
      }
   ],
   "TimestreamSettings": { 
      "CdcInsertsAndUpdates": boolean,
      "DatabaseName": "string",
      "EnableMagneticStoreWrites": boolean,
      "MagneticDuration": number,
      "MemoryDuration": number
   },
   "Username": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CertificateArn

The Amazon Resource Name (ARN) for the certificate.

Type: String

Required: No

DatabaseName

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 targetDbType.

Type: String

Required: No

DmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

  • ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

  • BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

Type: DmsTransferSettings object

Required: No

DocDbSettings

Provides information that defines a DocumentDB endpoint.

Type: DocDbSettings object

Required: No

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 in the AWS Database Migration Service User Guide.

Type: DynamoDbSettings object

Required: No

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 in the AWS Database Migration Service User Guide.

Type: ElasticsearchSettings object

Required: No

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.

Type: String

Required: Yes

EndpointType

The type of endpoint. Valid values are source and target.

Type: String

Valid Values: source | target

Required: Yes

EngineName

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", "babelfish", redshift-serverless, aurora-serverless, aurora-postgresql-serverless, gcp-mysql, azure-sql-managed-instance, redis, dms-transfer.

Type: String

Required: Yes

ExternalTableDefinition

The external table definition.

Type: String

Required: No

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 in the AWS Database Migration Service User Guide.

Type: String

Required: No

GcpMySQLSettings

Settings in JSON format for the source GCP MySQL endpoint.

Type: GcpMySQLSettings object

Required: No

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 in the AWS Database Migration Service User Guide.

Type: IBMDb2Settings object

Required: No

KafkaSettings

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide.

Type: KafkaSettings object

Required: No

KinesisSettings

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide.

Type: KinesisSettings object

Required: No

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, then 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.

Type: String

Required: No

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 and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.

Type: MicrosoftSQLServerSettings object

Required: No

MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for AWS Database Migration Service in the AWS Database Migration Service User Guide.

Type: MongoDbSettings object

Required: No

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 and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.

Type: MySQLSettings object

Required: No

NeptuneSettings

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the AWS Database Migration Service User Guide.

Type: NeptuneSettings object

Required: No

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 and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.

Type: OracleSettings object

Required: No

Password

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

Type: String

Required: No

Port

The port used by the endpoint database.

Type: Integer

Required: No

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 and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.

Type: PostgreSQLSettings object

Required: No

RedisSettings

Settings in JSON format for the target Redis endpoint.

Type: RedisSettings object

Required: No

RedshiftSettings

Provides information that defines an Amazon Redshift endpoint.

Type: RedshiftSettings object

Required: No

ResourceIdentifier

A friendly 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.

Type: String

Required: No

S3Settings

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

Type: S3Settings object

Required: No

ServerName

The name of the server where the endpoint database resides.

Type: String

Required: No

ServiceAccessRoleArn

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

Type: String

Required: No

SslMode

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

Type: String

Valid Values: none | require | verify-ca | verify-full

Required: No

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 and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.

Type: SybaseSettings object

Required: No

Tags

One or more tags to be assigned to the endpoint.

Type: Array of Tag objects

Required: No

TimestreamSettings

Settings in JSON format for the target Amazon Timestream endpoint.

Type: TimestreamSettings object

Required: No

Username

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

Type: String

Required: No

Response Syntax

{
   "Endpoint": { 
      "CertificateArn": "string",
      "DatabaseName": "string",
      "DmsTransferSettings": { 
         "BucketName": "string",
         "ServiceAccessRoleArn": "string"
      },
      "DocDbSettings": { 
         "DatabaseName": "string",
         "DocsToInvestigate": number,
         "ExtractDocId": boolean,
         "KmsKeyId": "string",
         "NestingLevel": "string",
         "Password": "string",
         "Port": number,
         "ReplicateShardCollections": boolean,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "Username": "string",
         "UseUpdateLookUp": boolean
      },
      "DynamoDbSettings": { 
         "ServiceAccessRoleArn": "string"
      },
      "ElasticsearchSettings": { 
         "EndpointUri": "string",
         "ErrorRetryDuration": number,
         "FullLoadErrorPercentage": number,
         "ServiceAccessRoleArn": "string",
         "UseNewMappingType": boolean
      },
      "EndpointArn": "string",
      "EndpointIdentifier": "string",
      "EndpointType": "string",
      "EngineDisplayName": "string",
      "EngineName": "string",
      "ExternalId": "string",
      "ExternalTableDefinition": "string",
      "ExtraConnectionAttributes": "string",
      "GcpMySQLSettings": { 
         "AfterConnectScript": "string",
         "CleanSourceMetadataOnMismatch": boolean,
         "DatabaseName": "string",
         "EventsPollInterval": number,
         "MaxFileSize": number,
         "ParallelLoadThreads": number,
         "Password": "string",
         "Port": number,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "ServerTimezone": "string",
         "TargetDbType": "string",
         "Username": "string"
      },
      "IBMDb2Settings": { 
         "CurrentLsn": "string",
         "DatabaseName": "string",
         "KeepCsvFiles": boolean,
         "LoadTimeout": number,
         "MaxFileSize": number,
         "MaxKBytesPerRead": number,
         "Password": "string",
         "Port": number,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "SetDataCaptureChanges": boolean,
         "Username": "string",
         "WriteBufferSize": number
      },
      "KafkaSettings": { 
         "Broker": "string",
         "IncludeControlDetails": boolean,
         "IncludeNullAndEmpty": boolean,
         "IncludePartitionValue": boolean,
         "IncludeTableAlterOperations": boolean,
         "IncludeTransactionDetails": boolean,
         "MessageFormat": "string",
         "MessageMaxBytes": number,
         "NoHexPrefix": boolean,
         "PartitionIncludeSchemaTable": boolean,
         "SaslMechanism": "string",
         "SaslPassword": "string",
         "SaslUsername": "string",
         "SecurityProtocol": "string",
         "SslCaCertificateArn": "string",
         "SslClientCertificateArn": "string",
         "SslClientKeyArn": "string",
         "SslClientKeyPassword": "string",
         "SslEndpointIdentificationAlgorithm": "string",
         "Topic": "string",
         "UseLargeIntegerValue": boolean
      },
      "KinesisSettings": { 
         "IncludeControlDetails": boolean,
         "IncludeNullAndEmpty": boolean,
         "IncludePartitionValue": boolean,
         "IncludeTableAlterOperations": boolean,
         "IncludeTransactionDetails": boolean,
         "MessageFormat": "string",
         "NoHexPrefix": boolean,
         "PartitionIncludeSchemaTable": boolean,
         "ServiceAccessRoleArn": "string",
         "StreamArn": "string",
         "UseLargeIntegerValue": boolean
      },
      "KmsKeyId": "string",
      "MicrosoftSQLServerSettings": { 
         "AuthenticationMethod": "string",
         "BcpPacketSize": number,
         "ControlTablesFileGroup": "string",
         "DatabaseName": "string",
         "ForceLobLookup": boolean,
         "Password": "string",
         "Port": number,
         "QuerySingleAlwaysOnNode": boolean,
         "ReadBackupOnly": boolean,
         "SafeguardPolicy": "string",
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "TlogAccessMode": "string",
         "TrimSpaceInChar": boolean,
         "UseBcpFullLoad": boolean,
         "Username": "string",
         "UseThirdPartyBackupDevice": boolean
      },
      "MongoDbSettings": { 
         "AuthMechanism": "string",
         "AuthSource": "string",
         "AuthType": "string",
         "DatabaseName": "string",
         "DocsToInvestigate": "string",
         "ExtractDocId": "string",
         "KmsKeyId": "string",
         "NestingLevel": "string",
         "Password": "string",
         "Port": number,
         "ReplicateShardCollections": boolean,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "Username": "string",
         "UseUpdateLookUp": boolean
      },
      "MySQLSettings": { 
         "AfterConnectScript": "string",
         "AuthenticationMethod": "string",
         "CleanSourceMetadataOnMismatch": boolean,
         "DatabaseName": "string",
         "EventsPollInterval": number,
         "ExecuteTimeout": number,
         "MaxFileSize": number,
         "ParallelLoadThreads": number,
         "Password": "string",
         "Port": number,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "ServerTimezone": "string",
         "ServiceAccessRoleArn": "string",
         "TargetDbType": "string",
         "Username": "string"
      },
      "NeptuneSettings": { 
         "ErrorRetryDuration": number,
         "IamAuthEnabled": boolean,
         "MaxFileSize": number,
         "MaxRetryCount": number,
         "S3BucketFolder": "string",
         "S3BucketName": "string",
         "ServiceAccessRoleArn": "string"
      },
      "OracleSettings": { 
         "AccessAlternateDirectly": boolean,
         "AdditionalArchivedLogDestId": number,
         "AddSupplementalLogging": boolean,
         "AllowSelectNestedTables": boolean,
         "ArchivedLogDestId": number,
         "ArchivedLogsOnly": boolean,
         "AsmPassword": "string",
         "AsmServer": "string",
         "AsmUser": "string",
         "AuthenticationMethod": "string",
         "CharLengthSemantics": "string",
         "ConvertTimestampWithZoneToUTC": boolean,
         "DatabaseName": "string",
         "DirectPathNoLog": boolean,
         "DirectPathParallelLoad": boolean,
         "EnableHomogenousTablespace": boolean,
         "ExtraArchivedLogDestIds": [ number ],
         "FailTasksOnLobTruncation": boolean,
         "NumberDatatypeScale": number,
         "OpenTransactionWindow": number,
         "OraclePathPrefix": "string",
         "ParallelAsmReadThreads": number,
         "Password": "string",
         "Port": number,
         "ReadAheadBlocks": number,
         "ReadTableSpaceName": boolean,
         "ReplacePathPrefix": boolean,
         "RetryInterval": number,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerOracleAsmAccessRoleArn": "string",
         "SecretsManagerOracleAsmSecretId": "string",
         "SecretsManagerSecretId": "string",
         "SecurityDbEncryption": "string",
         "SecurityDbEncryptionName": "string",
         "ServerName": "string",
         "SpatialDataOptionToGeoJsonFunctionName": "string",
         "StandbyDelayTime": number,
         "TrimSpaceInChar": boolean,
         "UseAlternateFolderForOnline": boolean,
         "UseBFile": boolean,
         "UseDirectPathFullLoad": boolean,
         "UseLogminerReader": boolean,
         "UsePathPrefix": "string",
         "Username": "string"
      },
      "Port": number,
      "PostgreSQLSettings": { 
         "AfterConnectScript": "string",
         "AuthenticationMethod": "string",
         "BabelfishDatabaseName": "string",
         "CaptureDdls": boolean,
         "DatabaseMode": "string",
         "DatabaseName": "string",
         "DdlArtifactsSchema": "string",
         "DisableUnicodeSourceFilter": boolean,
         "ExecuteTimeout": number,
         "FailTasksOnLobTruncation": boolean,
         "HeartbeatEnable": boolean,
         "HeartbeatFrequency": number,
         "HeartbeatSchema": "string",
         "MapBooleanAsBoolean": boolean,
         "MapJsonbAsClob": boolean,
         "MapLongVarcharAs": "string",
         "MaxFileSize": number,
         "Password": "string",
         "PluginName": "string",
         "Port": number,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "ServiceAccessRoleArn": "string",
         "SlotName": "string",
         "TrimSpaceInChar": boolean,
         "Username": "string"
      },
      "RedisSettings": { 
         "AuthPassword": "string",
         "AuthType": "string",
         "AuthUserName": "string",
         "Port": number,
         "ServerName": "string",
         "SslCaCertificateArn": "string",
         "SslSecurityProtocol": "string"
      },
      "RedshiftSettings": { 
         "AcceptAnyDate": boolean,
         "AfterConnectScript": "string",
         "BucketFolder": "string",
         "BucketName": "string",
         "CaseSensitiveNames": boolean,
         "CompUpdate": boolean,
         "ConnectionTimeout": number,
         "DatabaseName": "string",
         "DateFormat": "string",
         "EmptyAsNull": boolean,
         "EncryptionMode": "string",
         "ExplicitIds": boolean,
         "FileTransferUploadStreams": number,
         "LoadTimeout": number,
         "MapBooleanAsBoolean": boolean,
         "MaxFileSize": number,
         "Password": "string",
         "Port": number,
         "RemoveQuotes": boolean,
         "ReplaceChars": "string",
         "ReplaceInvalidChars": "string",
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "ServerSideEncryptionKmsKeyId": "string",
         "ServiceAccessRoleArn": "string",
         "TimeFormat": "string",
         "TrimBlanks": boolean,
         "TruncateColumns": boolean,
         "Username": "string",
         "WriteBufferSize": number
      },
      "S3Settings": { 
         "AddColumnName": boolean,
         "AddTrailingPaddingCharacter": boolean,
         "BucketFolder": "string",
         "BucketName": "string",
         "CannedAclForObjects": "string",
         "CdcInsertsAndUpdates": boolean,
         "CdcInsertsOnly": boolean,
         "CdcMaxBatchInterval": number,
         "CdcMinFileSize": number,
         "CdcPath": "string",
         "CompressionType": "string",
         "CsvDelimiter": "string",
         "CsvNoSupValue": "string",
         "CsvNullValue": "string",
         "CsvRowDelimiter": "string",
         "DataFormat": "string",
         "DataPageSize": number,
         "DatePartitionDelimiter": "string",
         "DatePartitionEnabled": boolean,
         "DatePartitionSequence": "string",
         "DatePartitionTimezone": "string",
         "DictPageSizeLimit": number,
         "EnableStatistics": boolean,
         "EncodingType": "string",
         "EncryptionMode": "string",
         "ExpectedBucketOwner": "string",
         "ExternalTableDefinition": "string",
         "GlueCatalogGeneration": boolean,
         "IgnoreHeaderRows": number,
         "IncludeOpForFullLoad": boolean,
         "MaxFileSize": number,
         "ParquetTimestampInMillisecond": boolean,
         "ParquetVersion": "string",
         "PreserveTransactions": boolean,
         "Rfc4180": boolean,
         "RowGroupLength": number,
         "ServerSideEncryptionKmsKeyId": "string",
         "ServiceAccessRoleArn": "string",
         "TimestampColumnName": "string",
         "UseCsvNoSupValue": boolean,
         "UseTaskStartTimeForFullLoadTimestamp": boolean
      },
      "ServerName": "string",
      "ServiceAccessRoleArn": "string",
      "SslMode": "string",
      "Status": "string",
      "SybaseSettings": { 
         "DatabaseName": "string",
         "Password": "string",
         "Port": number,
         "SecretsManagerAccessRoleArn": "string",
         "SecretsManagerSecretId": "string",
         "ServerName": "string",
         "Username": "string"
      },
      "TimestreamSettings": { 
         "CdcInsertsAndUpdates": boolean,
         "DatabaseName": "string",
         "EnableMagneticStoreWrites": boolean,
         "MagneticDuration": number,
         "MemoryDuration": number
      },
      "Username": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Endpoint

The endpoint that was created.

Type: Endpoint object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedFault

AWS DMS was denied access to the endpoint. Check that the role is correctly configured.

message

HTTP Status Code: 400

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

message

HTTP Status Code: 400

KMSKeyNotAccessibleFault

AWS DMS cannot access the KMS key.

message

HTTP Status Code: 400

ResourceAlreadyExistsFault

The resource you are attempting to create already exists.

message

resourceArn

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

message

HTTP Status Code: 400

ResourceQuotaExceededFault

The quota for this resource quota has been exceeded.

message

HTTP Status Code: 400

S3AccessDeniedFault

Insufficient privileges are preventing access to an Amazon S3 object.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateEndpoint.

Sample Request


      POST / HTTP/1.1
      Host: dms.<region>.<domain>
       x-amz-Date: <Date>
        Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
         User-Agent: <UserAgentString>
          Content-Type: application/x-amz-json-1.1
          Content-Length: <PayloadSizeBytes>
           Connection: Keep-Alive
           X-Amz-Target: AmazonDMSv20160101.CreateEndpoint
{
   "EndpointIdentifier":"test-endpoint-1", 
           "   EndpointType":"source", 
           "   EngineName":"mysql",
   "Username":"username",
   "Password":"password",
   "ServerName":"test-source.cxln7iyxx1lo.us-west-2.rds.amazonaws.com", 
           "   Port":3306,
   "DatabaseName":"",
   "ExtraConnectionAttributes":"",
   "KmsKeyId":"",
   "Tags":[
      {
         "Key":"",
         "Value":""
      }
   ]
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date> 
{
   "Endpoint":{
      "Username":"username",
      "Status":"active",
      "EndpointArn":"arn:aws:dms:us-east-
1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
      "ServerName":"test-source.cxln7iyxx1lo.us-west-2.rds.amazonaws.com",
      "EndpointType":"SOURCE",
      "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:key/4dc17316-5543-
4ded-b1e3-d53a7cfb411d",
      "EngineName":"mysql",
      "EndpointIdentifier":"test-endpoint-1",
      "Port":3306
   }
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: