Menu
AWS Database Migration Service
API Reference (API Version 2016-01-01)

CreateEndpoint

Creates an endpoint using the provided settings.

Request Syntax

{
   "CertificateArn": "string",
   "DatabaseName": "string",
   "DynamoDbSettings": { 
      "ServiceAccessRoleArn": "string"
   },
   "EndpointIdentifier": "string",
   "EndpointType": "string",
   "EngineName": "string",
   "ExtraConnectionAttributes": "string",
   "KmsKeyId": "string",
   "MongoDbSettings": { 
      "AuthMechanism": "string",
      "AuthSource": "string",
      "AuthType": "string",
      "DatabaseName": "string",
      "DocsToInvestigate": "string",
      "ExtractDocId": "string",
      "NestingLevel": "string",
      "Password": "string",
      "Port": number,
      "ServerName": "string",
      "Username": "string"
   },
   "Password": "string",
   "Port": number,
   "S3Settings": { 
      "BucketFolder": "string",
      "BucketName": "string",
      "CompressionType": "string",
      "CsvDelimiter": "string",
      "CsvRowDelimiter": "string",
      "ExternalTableDefinition": "string",
      "ServiceAccessRoleArn": "string"
   },
   "ServerName": "string",
   "SslMode": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "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.

Type: String

Required: No

DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

Type: DynamoDbSettings object

Required: No

EndpointIdentifier

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Type: String

Required: Yes

EndpointType

The type of endpoint.

Type: String

Valid Values: source | target

Required: Yes

EngineName

The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.

Type: String

Required: Yes

ExtraConnectionAttributes

Additional attributes associated with the connection.

Type: String

Required: No

KmsKeyId

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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

MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Type: MongoDbSettings object

Required: No

Password

The password to be used to login to the endpoint database.

Type: String

Required: No

Port

The port used by the endpoint database.

Type: Integer

Required: No

S3Settings

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

Type: S3Settings object

Required: No

ServerName

The name of the server where the endpoint database resides.

Type: String

Required: No

SslMode

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Type: String

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

Required: No

Tags

Tags to be added to the endpoint.

Type: Array of Tag objects

Required: No

Username

The user name to be used to login to the endpoint database.

Type: String

Required: No

Response Syntax

{
   "Endpoint": { 
      "CertificateArn": "string",
      "DatabaseName": "string",
      "DynamoDbSettings": { 
         "ServiceAccessRoleArn": "string"
      },
      "EndpointArn": "string",
      "EndpointIdentifier": "string",
      "EndpointType": "string",
      "EngineName": "string",
      "ExternalId": "string",
      "ExtraConnectionAttributes": "string",
      "KmsKeyId": "string",
      "MongoDbSettings": { 
         "AuthMechanism": "string",
         "AuthSource": "string",
         "AuthType": "string",
         "DatabaseName": "string",
         "DocsToInvestigate": "string",
         "ExtractDocId": "string",
         "NestingLevel": "string",
         "Password": "string",
         "Port": number,
         "ServerName": "string",
         "Username": "string"
      },
      "Port": number,
      "S3Settings": { 
         "BucketFolder": "string",
         "BucketName": "string",
         "CompressionType": "string",
         "CsvDelimiter": "string",
         "CsvRowDelimiter": "string",
         "ExternalTableDefinition": "string",
         "ServiceAccessRoleArn": "string"
      },
      "ServerName": "string",
      "SslMode": "string",
      "Status": "string",
      "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.

HTTP Status Code: 400

InvalidResourceStateFault

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

HTTP Status Code: 400

KMSKeyNotAccessibleFault

AWS DMS cannot access the KMS key.

HTTP Status Code: 400

ResourceAlreadyExistsFault

The resource you are attempting to create already exists.

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

ResourceQuotaExceededFault

The quota for this resource quota has been exceeded.

HTTP Status Code: 400

Example

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:152683116123:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
      "ServerName":"test-source.cxln7iyxx1lo.us-west-2.rds.amazonaws.com",
      "EndpointType":"SOURCE",
      "KmsKeyId":"arn:aws:kms:us-east-1:152683116123: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: