Menu
AWS Database Migration Service
API Reference (API Version 2016-01-01)

Endpoint

Contents

CertificateArn

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

Type: String

Required: No

DatabaseName

The name of the database at the endpoint.

Type: String

Required: No

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

Type: DmsTransferSettings object

Required: No

DynamoDbSettings

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

Type: DynamoDbSettings object

Required: No

EndpointArn

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

Type: String

Required: No

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.

Type: String

Required: No

EndpointType

The type of endpoint.

Type: String

Valid Values: source | target

Required: No

EngineDisplayName

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

Type: String

Required: No

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.

Type: String

Required: No

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.

Type: String

Required: No

ExternalTableDefinition

The external table definition.

Type: String

Required: No

ExtraConnectionAttributes

Additional connection attributes used to connect to the endpoint.

Type: String

Required: No

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.

Type: String

Required: No

MongoDbSettings

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

Type: MongoDbSettings object

Required: No

Port

The port value used to access the endpoint.

Type: Integer

Required: No

S3Settings

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

Type: S3Settings object

Required: No

ServerName

The name of the server at the endpoint.

Type: String

Required: No

ServiceAccessRoleArn

The Amazon Resource Name (ARN) used by the service access IAM role.

Type: String

Required: No

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.

Type: String

Valid Values: none | require | verify-ca | verify-full

Required: No

Status

The status of the endpoint.

Type: String

Required: No

Username

The user name used to connect to the endpoint.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: