Endpoint - AWS Database Migration Service

Endpoint

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

  • CreateEndpoint

  • DescribeEndpoint

  • DescribeEndpointTypes

  • ModifyEndpoint

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 of source endpoint.

Possible settings include the following:

  • 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. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these settings is as follows: { "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

ElasticsearchSettings

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

Type: ElasticsearchSettings 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 and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

Type: String

Required: No

EndpointType

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

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", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

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

KafkaSettings

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

Type: KafkaSettings object

Required: No

KinesisSettings

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

Type: KinesisSettings object

Required: No

KmsKeyId

An AWS 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 AWS DMS uses 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

NeptuneSettings

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

Type: NeptuneSettings object

Required: No

Port

The port value used to access the endpoint.

Type: Integer

Required: No

RedshiftSettings

Settings for the Amazon Redshift endpoint.

Type: RedshiftSettings object

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