AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes an endpoint of a database instance in response to operations such as the following:

Inheritance Hierarchy

System.Object
  Amazon.DatabaseMigrationService.Model.Endpoint

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

Syntax

C#
public class Endpoint

The Endpoint type exposes the following members

Constructors

NameDescription
Public Method Endpoint()

Properties

NameTypeDescription
Public Property CertificateArn System.String

Gets and sets the property CertificateArn.

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

Public Property DatabaseName System.String

Gets and sets the property DatabaseName.

The name of the database at the endpoint.

Public Property DmsTransferSettings Amazon.DatabaseMigrationService.Model.DmsTransferSettings

Gets and sets the property DmsTransferSettings.

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

Public Property DocDbSettings Amazon.DatabaseMigrationService.Model.DocDbSettings

Gets and sets the property DocDbSettings.

Public Property DynamoDbSettings Amazon.DatabaseMigrationService.Model.DynamoDbSettings

Gets and sets the property DynamoDbSettings.

The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

Public Property ElasticsearchSettings Amazon.DatabaseMigrationService.Model.ElasticsearchSettings

Gets and sets the property ElasticsearchSettings.

The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.

Public Property EndpointArn System.String

Gets and sets the property EndpointArn.

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Public Property 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.

Public Property EndpointType Amazon.DatabaseMigrationService.ReplicationEndpointTypeValue

Gets and sets the property EndpointType.

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

Public Property EngineDisplayName System.String

Gets and sets the property EngineDisplayName.

The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

Public Property EngineName System.String

Gets and sets the property EngineName.

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

Public Property ExternalId System.String

Gets and sets the property ExternalId.

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

Public Property ExternalTableDefinition System.String

Gets and sets the property ExternalTableDefinition.

The external table definition.

Public Property ExtraConnectionAttributes System.String

Gets and sets the property ExtraConnectionAttributes.

Additional connection attributes used to connect to the endpoint.

Public Property GcpMySQLSettings Amazon.DatabaseMigrationService.Model.GcpMySQLSettings

Gets and sets the property GcpMySQLSettings.

Settings in JSON format for the source GCP MySQL endpoint.

Public Property IBMDb2Settings Amazon.DatabaseMigrationService.Model.IBMDb2Settings

Gets and sets the property IBMDb2Settings.

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

Public Property KafkaSettings Amazon.DatabaseMigrationService.Model.KafkaSettings

Gets and sets the property KafkaSettings.

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

Public Property KinesisSettings Amazon.DatabaseMigrationService.Model.KinesisSettings

Gets and sets the property KinesisSettings.

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

Public Property 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.

Public Property MicrosoftSQLServerSettings Amazon.DatabaseMigrationService.Model.MicrosoftSQLServerSettings

Gets and sets the property MicrosoftSQLServerSettings.

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

Public Property MongoDbSettings Amazon.DatabaseMigrationService.Model.MongoDbSettings

Gets and sets the property MongoDbSettings.

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

Public Property MySQLSettings Amazon.DatabaseMigrationService.Model.MySQLSettings

Gets and sets the property MySQLSettings.

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

Public Property NeptuneSettings Amazon.DatabaseMigrationService.Model.NeptuneSettings

Gets and sets the property NeptuneSettings.

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

Public Property OracleSettings Amazon.DatabaseMigrationService.Model.OracleSettings

Gets and sets the property OracleSettings.

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

Public Property Port System.Int32

Gets and sets the property Port.

The port value used to access the endpoint.

Public Property PostgreSQLSettings Amazon.DatabaseMigrationService.Model.PostgreSQLSettings

Gets and sets the property PostgreSQLSettings.

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

Public Property RedisSettings Amazon.DatabaseMigrationService.Model.RedisSettings

Gets and sets the property RedisSettings.

The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

Public Property RedshiftSettings Amazon.DatabaseMigrationService.Model.RedshiftSettings

Gets and sets the property RedshiftSettings.

Settings for the Amazon Redshift endpoint.

Public Property S3Settings Amazon.DatabaseMigrationService.Model.S3Settings

Gets and sets the property S3Settings.

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

Public Property ServerName System.String

Gets and sets the property ServerName.

The name of the server at the endpoint.

Public Property ServiceAccessRoleArn System.String

Gets and sets the property ServiceAccessRoleArn.

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

Public Property SslMode Amazon.DatabaseMigrationService.DmsSslModeValue

Gets and sets the property SslMode.

The SSL mode used to connect to the endpoint. The default value is none.

Public Property Status System.String

Gets and sets the property Status.

The status of the endpoint.

Public Property SybaseSettings Amazon.DatabaseMigrationService.Model.SybaseSettings

Gets and sets the property SybaseSettings.

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

Public Property TimestreamSettings Amazon.DatabaseMigrationService.Model.TimestreamSettings

Gets and sets the property TimestreamSettings.

The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.

Public Property Username System.String

Gets and sets the property Username.

The user name used to connect to the endpoint.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5