Endpoint

import type { Endpoint } from "https://aws-api.deno.dev/v0.3/services/dms.ts?docs=full";

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

```
CreateEndpoint
```
```
DescribeEndpoint
```
```
ModifyEndpoint
```

interface Endpoint {

CertificateArn?: string | null;

DatabaseName?: string | null;

DmsTransferSettings?: DmsTransferSettings | null;

DocDbSettings?: DocDbSettings | null;

DynamoDbSettings?: DynamoDbSettings | null;

ElasticsearchSettings?: ElasticsearchSettings | null;

EndpointArn?: string | null;

EndpointIdentifier?: string | null;

EndpointType?: ReplicationEndpointTypeValue | null;

EngineDisplayName?: string | null;

EngineName?: string | null;

ExternalId?: string | null;

ExternalTableDefinition?: string | null;

ExtraConnectionAttributes?: string | null;

GcpMySQLSettings?: GcpMySQLSettings | null;

IBMDb2Settings?: IBMDb2Settings | null;

KafkaSettings?: KafkaSettings | null;

KinesisSettings?: KinesisSettings | null;

KmsKeyId?: string | null;

MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings | null;

MongoDbSettings?: MongoDbSettings | null;

MySQLSettings?: MySQLSettings | null;

NeptuneSettings?: NeptuneSettings | null;

OracleSettings?: OracleSettings | null;

Port?: number | null;

PostgreSQLSettings?: PostgreSQLSettings | null;

RedisSettings?: RedisSettings | null;

RedshiftSettings?: RedshiftSettings | null;

S3Settings?: S3Settings | null;

ServerName?: string | null;

ServiceAccessRoleArn?: string | null;

SslMode?: DmsSslModeValue | null;

Status?: string | null;

SybaseSettings?: SybaseSettings | null;

Username?: string | null;

}

§Properties

CertificateArn?: string | null

[src]

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

DatabaseName?: string | null

[src]

The name of the database at the endpoint.

DmsTransferSettings?: DmsTransferSettings | null

[src]

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

DocDbSettings?: DocDbSettings | null

[src]

DynamoDbSettings?: DynamoDbSettings | null

[src]

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

ElasticsearchSettings?: ElasticsearchSettings | null

[src]

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

EndpointArn?: string | null

[src]

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

EndpointIdentifier?: string | null

[src]

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.

EndpointType?: ReplicationEndpointTypeValue | null

[src]

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

EngineDisplayName?: string | null

[src]

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

EngineName?: string | null

[src]

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

ExternalId?: string | null

[src]

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.

ExternalTableDefinition?: string | null

[src]

The external table definition.

ExtraConnectionAttributes?: string | null

[src]

Additional connection attributes used to connect to the endpoint.

GcpMySQLSettings?: GcpMySQLSettings | null

[src]

Settings in JSON format for the source GCP MySQL endpoint.

IBMDb2Settings?: IBMDb2Settings | null

[src]

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

KafkaSettings?: KafkaSettings | null

[src]

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

KinesisSettings?: KinesisSettings | null

[src]

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

KmsKeyId?: string | null

[src]

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

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.

MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings | null

[src]

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

MongoDbSettings?: MongoDbSettings | null

[src]

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

MySQLSettings?: MySQLSettings | null

[src]

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

NeptuneSettings?: NeptuneSettings | null

[src]

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

OracleSettings?: OracleSettings | null

[src]

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

Port?: number | null

[src]

The port value used to access the endpoint.

PostgreSQLSettings?: PostgreSQLSettings | null

[src]

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

RedisSettings?: RedisSettings | null

[src]

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

RedshiftSettings?: RedshiftSettings | null

[src]

Settings for the Amazon Redshift endpoint.

S3Settings?: S3Settings | null

[src]

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

ServerName?: string | null

[src]

The name of the server at the endpoint.

ServiceAccessRoleArn?: string | null

[src]

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

SslMode?: DmsSslModeValue | null

[src]

The SSL mode used to connect to the endpoint. The default value is none.

Status?: string | null

[src]

The status of the endpoint.

SybaseSettings?: SybaseSettings | null

[src]

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

Username?: string | null

[src]

The user name used to connect to the endpoint.