CreateEndpointRequest Class | AWS SDK for .NET V3

Container for the parameters to the CreateEndpoint operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DatabaseMigrationService.AmazonDatabaseMigrationServiceRequest
      Amazon.DatabaseMigrationService.Model.CreateEndpointRequest

Namespace: Amazon.DatabaseMigrationService.Model
Assembly: AWSSDK.DatabaseMigrationService.dll
Version: 3.x.y.z

Syntax

public class CreateEndpointRequest : AmazonDatabaseMigrationServiceRequest
         IAmazonWebServiceRequest

The CreateEndpointRequest type exposes the following members

Constructors

	Name	Description
	CreateEndpointRequest()

Properties

Name	Type	Description
CertificateArn	System.String	Gets and sets the property CertificateArn. The Amazon Resource Name (ARN) for the certificate.
DatabaseName	System.String	Gets and sets the property 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`.
DmsTransferSettings	Amazon.DatabaseMigrationService.Model.DmsTransferSettings	Gets and sets the property 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", }`
DocDbSettings	Amazon.DatabaseMigrationService.Model.DocDbSettings	Gets and sets the property DocDbSettings.
DynamoDbSettings	Amazon.DatabaseMigrationService.Model.DynamoDbSettings	Gets and sets the property 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 Database Migration Service User Guide.
ElasticsearchSettings	Amazon.DatabaseMigrationService.Model.ElasticsearchSettings	Gets and sets the property 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 DMS in the Database Migration Service User Guide.
EndpointIdentifier	System.String	Gets and sets the property 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.
EndpointType	Amazon.DatabaseMigrationService.ReplicationEndpointTypeValue	Gets and sets the property EndpointType. The type of endpoint. Valid values are `source` and `target`.
EngineName	System.String	Gets and sets the property 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`.
ExternalTableDefinition	System.String	Gets and sets the property ExternalTableDefinition. The external table definition.
ExtraConnectionAttributes	System.String	Gets and sets the property 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 DMS Endpoints in the Database Migration Service User Guide.
GcpMySQLSettings	Amazon.DatabaseMigrationService.Model.GcpMySQLSettings	Gets and sets the property GcpMySQLSettings. Settings in JSON format for the source GCP MySQL endpoint.
IBMDb2Settings	Amazon.DatabaseMigrationService.Model.IBMDb2Settings	Gets and sets the property 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 DMS in the Database Migration Service User Guide.
KafkaSettings	Amazon.DatabaseMigrationService.Model.KafkaSettings	Gets and sets the property 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 Database Migration Service User Guide.
KinesisSettings	Amazon.DatabaseMigrationService.Model.KinesisSettings	Gets and sets the property 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 Database Migration Service User Guide.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. An 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 DMS uses your default encryption key. 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.
MicrosoftSQLServerSettings	Amazon.DatabaseMigrationService.Model.MicrosoftSQLServerSettings	Gets and sets the property 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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
MongoDbSettings	Amazon.DatabaseMigrationService.Model.MongoDbSettings	Gets and sets the property 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 Database Migration Service in the Database Migration Service User Guide.
MySQLSettings	Amazon.DatabaseMigrationService.Model.MySQLSettings	Gets and sets the property 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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
NeptuneSettings	Amazon.DatabaseMigrationService.Model.NeptuneSettings	Gets and sets the property 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 Database Migration Service User Guide.
OracleSettings	Amazon.DatabaseMigrationService.Model.OracleSettings	Gets and sets the property 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 DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
Password	System.String	Gets and sets the property Password. The password to be used to log in to the endpoint database.
Port	System.Int32	Gets and sets the property Port. The port used by the endpoint database.
PostgreSQLSettings	Amazon.DatabaseMigrationService.Model.PostgreSQLSettings	Gets and sets the property 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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
RedisSettings	Amazon.DatabaseMigrationService.Model.RedisSettings	Gets and sets the property RedisSettings. Settings in JSON format for the target Redis endpoint.
RedshiftSettings	Amazon.DatabaseMigrationService.Model.RedshiftSettings	Gets and sets the property RedshiftSettings.
ResourceIdentifier	System.String	Gets and sets the property 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, DMS generates a default identifier value for the end of `EndpointArn`.
S3Settings	Amazon.DatabaseMigrationService.Model.S3Settings	Gets and sets the property 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 DMS in the Database Migration Service User Guide.
ServerName	System.String	Gets and sets the property ServerName. The name of the server where the endpoint database resides.
ServiceAccessRoleArn	System.String	Gets and sets the property 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.
SslMode	Amazon.DatabaseMigrationService.DmsSslModeValue	Gets and sets the property SslMode. The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is `none`
SybaseSettings	Amazon.DatabaseMigrationService.Model.SybaseSettings	Gets and sets the property 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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
Tags	System.Collections.Generic.List<Amazon.DatabaseMigrationService.Model.Tag>	Gets and sets the property Tags. One or more tags to be assigned to the endpoint.
TimestreamSettings	Amazon.DatabaseMigrationService.Model.TimestreamSettings	Gets and sets the property TimestreamSettings. Settings in JSON format for the target Amazon Timestream endpoint.
Username	System.String	Gets and sets the property Username. The user name to be used to log in to the endpoint database.

Examples

Creates an endpoint using the provided settings.

Create endpoint


var client = new AmazonDatabaseMigrationServiceClient();
var response = client.CreateEndpoint(new CreateEndpointRequest 
{
    CertificateArn = "",
    DatabaseName = "testdb",
    EndpointIdentifier = "test-endpoint-1",
    EndpointType = "source",
    EngineName = "mysql",
    ExtraConnectionAttributes = "",
    KmsKeyId = "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
    Password = "pasword",
    Port = 3306,
    ServerName = "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
    SslMode = "require",
    Tags = new List<Tag> {
        new Tag {
            Key = "Acount",
            Value = "143327655"
        }
    },
    Username = "username"
});

Endpoint endpoint = response.Endpoint;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5