Endpoint

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

CreateEndpoint
DescribeEndpoint
ModifyEndpoint

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 for the Amazon DMS Transfer type source. For more information, see the DmsTransferSettings structure.

Type: DmsTransferSettings object

Required: No

DocDbSettings

Provides information that defines a DocumentDB endpoint.

Type: DocDbSettings object

Required: No

DynamoDbSettings

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

Type: DynamoDbSettings object

Required: No

ElasticsearchSettings

The settings for the OpenSearch 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", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

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

GcpMySQLSettings

Settings in JSON format for the source GCP MySQL endpoint.

Type: GcpMySQLSettings object

Required: No

IBMDb2Settings

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

Type: IBMDb2Settings object

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 Amazon 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 Amazon DMS uses your default encryption key.

Amazon KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Type: String

Required: No

MicrosoftSQLServerSettings

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

Type: MicrosoftSQLServerSettings object

Required: No

MongoDbSettings

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

Type: MongoDbSettings object

Required: No

MySQLSettings

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

Type: MySQLSettings object

Required: No

NeptuneSettings

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

Type: NeptuneSettings object

Required: No

OracleSettings

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

Type: OracleSettings object

Required: No

Port

The port value used to access the endpoint.

Type: Integer

Required: No

PostgreSQLSettings

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

Type: PostgreSQLSettings object

Required: No

RedisSettings

The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

Type: RedisSettings object

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 to access the IAM role. The role must allow the iam:PassRole action.

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

SybaseSettings

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

Type: SybaseSettings object

Required: No

TimestreamSettings

The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.

Type: TimestreamSettings object

Required: No

Username

The user name used to connect to the endpoint.

Type: String

Required: No

Endpoint

Contents

See Also