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.

Container for the parameters to the ModifyEndpoint operation. Modifies the specified endpoint.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify 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.ModifyEndpointRequest

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

Syntax

C# 
public class ModifyEndpointRequest : AmazonDatabaseMigrationServiceRequest
         IAmazonWebServiceRequest

The ModifyEndpointRequest type exposes the following members

Constructors

NameDescription
Public Method ModifyEndpointRequest()

Properties

NameTypeDescription
Public Property CertificateArn System.String

Gets and sets the property CertificateArn.

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

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

Public Property DmsTransferSettings Amazon.DatabaseMigrationService.Model.DmsTransferSettings

Gets and sets the property DmsTransferSettings.

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

Attributes 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"}

Public Property DocDbSettings Amazon.DatabaseMigrationService.Model.DocDbSettings

Gets and sets the property DocDbSettings.

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.
Public Property 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.
Public Property 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.
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 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", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

Public Property ExactSettings System.Boolean

Gets and sets the property ExactSettings.

If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

  • It replaces any endpoint settings that already exist with new values, for settings with the same names.

  • It creates new endpoint settings that you specify in the call, for settings with different names.

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

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 attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

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.

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.
Public Property 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.
Public Property 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.
Public Property 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.
Public Property 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 the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
Public Property 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.
Public Property 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.
Public Property 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.
Public Property Password System.String

Gets and sets the property Password.

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

Public Property Port System.Int32

Gets and sets the property Port.

The port used by the endpoint database.

Public Property 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.
Public Property RedisSettings Amazon.DatabaseMigrationService.Model.RedisSettings

Gets and sets the property RedisSettings.

Settings in JSON format for the Redis target endpoint.

Public Property RedshiftSettings Amazon.DatabaseMigrationService.Model.RedshiftSettings

Gets and sets the property RedshiftSettings.

Public Property 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.
Public Property ServerName System.String

Gets and sets the property ServerName.

The name of the server where the endpoint database resides.

Public Property ServiceAccessRoleArn System.String

Gets and sets the property ServiceAccessRoleArn.

The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. 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 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.
Public Property TimestreamSettings Amazon.DatabaseMigrationService.Model.TimestreamSettings

Gets and sets the property TimestreamSettings.

Settings in JSON format for the target Amazon Timestream endpoint.

Public Property Username System.String

Gets and sets the property Username.

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

Examples

Modifies the specified endpoint.

Modify endpoint


var client = new AmazonDatabaseMigrationServiceClient();
var response = client.ModifyEndpoint(new ModifyEndpointRequest 
{
    CertificateArn = "",
    DatabaseName = "",
    EndpointArn = "",
    EndpointIdentifier = "",
    EndpointType = "source",
    EngineName = "",
    ExtraConnectionAttributes = "",
    Password = "",
    Port = 123,
    ServerName = "",
    SslMode = "require",
    Username = ""
});

Endpoint endpoint = response.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