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 CreateEndpoint operation. Creates an endpoint using the provided settings.

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

C#
public class CreateEndpointRequest : AmazonDatabaseMigrationServiceRequest
         IAmazonWebServiceRequest

The CreateEndpointRequest type exposes the following members

Constructors

NameDescription
Public Method CreateEndpointRequest()

Properties

NameTypeDescription
Public Property CertificateArn System.String

Gets and sets the property CertificateArn.

The Amazon Resource Number (ARN) for the certificate.

Public Property DatabaseName System.String

Gets and sets the property DatabaseName.

The name of the endpoint database.

Public Property DynamoDbSettings Amazon.DatabaseMigrationService.Model.DynamoDbSettings

Gets and sets the property 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.

Public Property EndpointIdentifier System.String

Gets and sets the property 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.

Public Property EndpointType Amazon.DatabaseMigrationService.ReplicationEndpointTypeValue

Gets and sets the property EndpointType.

The type of endpoint.

Public Property EngineName System.String

Gets and sets the property 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.

Public Property ExtraConnectionAttributes System.String

Gets and sets the property ExtraConnectionAttributes.

Additional attributes associated with the connection.

Public Property KmsKeyId System.String

Gets and sets the property 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.

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 When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

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 S3Settings Amazon.DatabaseMigrationService.Model.S3Settings

Gets and sets the property 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.

Public Property ServerName System.String

Gets and sets the property ServerName.

The name of the server where the endpoint database resides.

Public Property SslMode Amazon.DatabaseMigrationService.DmsSslModeValue

Gets and sets the property 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.

Public Property Tags System.Collections.Generic.List<Amazon.DatabaseMigrationService.Model.Tag>

Gets and sets the property Tags.

Tags to be added to the 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

Creates an endpoint using the provided settings.

Create endpoint


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 {
        new Tag {
            Key = "Acount",
            Value = "143327655"
        }
    },
    Username = "username"
});

Endpoint endpoint = response.Endpoint;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms