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.

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 in JSON format for the DMS Transfer type source endpoint.

Attributes include:

  • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

  • bucketName - The name of the S3 bucket to use.

  • compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string

JSON syntax:

{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

Public Property DynamoDbSettings Amazon.DatabaseMigrationService.Model.DynamoDbSettings

Gets and sets the property DynamoDbSettings.

The settings for the target DynamoDB database. For more information, see the DynamoDBSettings 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; 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 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, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

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

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

Public Property Port System.Int32

Gets and sets the property Port.

The port value used to access the 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 access IAM role.

Public Property SslMode Amazon.DatabaseMigrationService.DmsSslModeValue

Gets and sets the property SslMode.

The SSL mode used to connect to the endpoint.

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

The default value is none.

Public Property Status System.String

Gets and sets the property Status.

The status of the endpoint.

Public Property Username System.String

Gets and sets the property Username.

The user name used to connect to the 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