CreateEndpointMessage

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

interface CreateEndpointMessage {

CertificateArn?: string | null;

DatabaseName?: string | null;

DmsTransferSettings?: DmsTransferSettings | null;

DocDbSettings?: DocDbSettings | null;

DynamoDbSettings?: DynamoDbSettings | null;

ElasticsearchSettings?: ElasticsearchSettings | null;

EndpointIdentifier: string;

EndpointType: ReplicationEndpointTypeValue;

EngineName: string;

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;

Password?: string | null;

Port?: number | null;

PostgreSQLSettings?: PostgreSQLSettings | null;

RedisSettings?: RedisSettings | null;

RedshiftSettings?: RedshiftSettings | null;

ResourceIdentifier?: string | null;

S3Settings?: S3Settings | null;

ServerName?: string | null;

ServiceAccessRoleArn?: string | null;

SslMode?: DmsSslModeValue | null;

SybaseSettings?: SybaseSettings | null;

Tags?: Tag[] | null;

Username?: string | null;

}

§Properties

CertificateArn?: string | null

[src]

The Amazon Resource Name (ARN) for the certificate.

DatabaseName?: string | null

[src]

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

DmsTransferSettings?: DmsTransferSettings | null

[src]

The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.

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

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

DocDbSettings?: DocDbSettings | null

[src]

DynamoDbSettings?: DynamoDbSettings | null

[src]

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

ElasticsearchSettings?: ElasticsearchSettings | null

[src]

Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

EndpointIdentifier: string

[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

[src]

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

EngineName: string

[src]

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

ExternalTableDefinition?: string | null

[src]

The external table definition.

ExtraConnectionAttributes?: string | null

[src]

Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.

GcpMySQLSettings?: GcpMySQLSettings | null

[src]

Settings in JSON format for the source GCP MySQL endpoint.

IBMDb2Settings?: IBMDb2Settings | null

[src]

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

KafkaSettings?: KafkaSettings | null

[src]

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

KinesisSettings?: KinesisSettings | null

[src]

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

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]

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

MongoDbSettings?: MongoDbSettings | null

[src]

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

MySQLSettings?: MySQLSettings | null

[src]

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

NeptuneSettings?: NeptuneSettings | null

[src]

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

OracleSettings?: OracleSettings | null

[src]

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

Password?: string | null

[src]

The password to be used to log in to the endpoint database.

Port?: number | null

[src]

The port used by the endpoint database.

PostgreSQLSettings?: PostgreSQLSettings | null

[src]

Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

RedisSettings?: RedisSettings | null

[src]

Settings in JSON format for the target Redis endpoint.

RedshiftSettings?: RedshiftSettings | null

[src]

ResourceIdentifier?: string | null

[src]

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

S3Settings?: S3Settings | null

[src]

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

ServerName?: string | null

[src]

The name of the server where the endpoint database resides.

ServiceAccessRoleArn?: string | null

[src]

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

SslMode?: DmsSslModeValue | null

[src]

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

SybaseSettings?: SybaseSettings | null

[src]

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

Tags?: Tag[] | null

[src]

One or more tags to be assigned to the endpoint.

Username?: string | null

[src]

The user name to be used to log in to the endpoint database.