Module Values.EndpointSource

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

Sourcetype nonrec t = {
  1. endpointIdentifier : String_.t option;
    (*

    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.

    *)
  2. endpointType : ReplicationEndpointTypeValue.t option;
    (*

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

    *)
  3. engineName : String_.t option;
    (*

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

    *)
  4. engineDisplayName : String_.t option;
    (*

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

    *)
  5. username : String_.t option;
    (*

    The user name used to connect to the endpoint.

    *)
  6. serverName : String_.t option;
    (*

    The name of the server at the endpoint.

    *)
  7. port : IntegerOptional.t option;
    (*

    The port value used to access the endpoint.

    *)
  8. databaseName : String_.t option;
    (*

    The name of the database at the endpoint.

    *)
  9. extraConnectionAttributes : String_.t option;
    (*

    Additional connection attributes used to connect to the endpoint.

    *)
  10. status : String_.t option;
    (*

    The status of the endpoint.

    *)
  11. kmsKeyId : String_.t option;
    (*

    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.

    *)
  12. endpointArn : String_.t option;
    (*

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

    *)
  13. certificateArn : String_.t option;
    (*

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

    *)
  14. sslMode : DmsSslModeValue.t option;
    (*

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

    *)
  15. serviceAccessRoleArn : String_.t option;
    (*

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

    *)
  16. externalTableDefinition : String_.t option;
    (*

    The external table definition.

    *)
  17. externalId : String_.t option;
    (*

    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.

    *)
  18. isReadOnly : BooleanOptional.t option;
    (*

    Indicates whether the endpoint is read-only. When set to true, this endpoint is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only endpoints through their associated zero-ETL integration.

    *)
  19. dynamoDbSettings : DynamoDbSettings.t option;
    (*

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

    *)
  20. s3Settings : S3Settings.t option;
    (*

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

    *)
  21. dmsTransferSettings : DmsTransferSettings.t option;
    (*

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

    *)
  22. mongoDbSettings : MongoDbSettings.t option;
    (*

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

    *)
  23. kinesisSettings : KinesisSettings.t option;
    (*

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

    *)
  24. kafkaSettings : KafkaSettings.t option;
    (*

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

    *)
  25. elasticsearchSettings : ElasticsearchSettings.t option;
    (*

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

    *)
  26. neptuneSettings : NeptuneSettings.t option;
    (*

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

    *)
  27. redshiftSettings : RedshiftSettings.t option;
    (*

    Settings for the Amazon Redshift endpoint.

    *)
  28. postgreSQLSettings : PostgreSQLSettings.t option;
    (*

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

    *)
  29. mySQLSettings : MySQLSettings.t option;
    (*

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

    *)
  30. oracleSettings : OracleSettings.t option;
    (*

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

    *)
  31. sybaseSettings : SybaseSettings.t option;
    (*

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

    *)
  32. microsoftSQLServerSettings : MicrosoftSQLServerSettings.t option;
    (*

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

    *)
  33. iBMDb2Settings : IBMDb2Settings.t option;
    (*

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

    *)
  34. docDbSettings : DocDbSettings.t option;
  35. redisSettings : RedisSettings.t option;
    (*

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

    *)
  36. gcpMySQLSettings : GcpMySQLSettings.t option;
    (*

    Settings in JSON format for the source GCP MySQL endpoint.

    *)
  37. timestreamSettings : TimestreamSettings.t option;
    (*

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

    *)
  38. lakehouseSettings : LakehouseSettings.t option;
    (*

    Settings in JSON format for the target Lakehouse endpoint. This parameter applies to endpoints that are automatically created by DMS for a Lakehouse data warehouse as part of a zero-ETL integration.

    *)
}
Sourceval make : ?endpointIdentifier:??? -> ?endpointType:??? -> ?engineName:??? -> ?engineDisplayName:??? -> ?username:??? -> ?serverName:??? -> ?port:??? -> ?databaseName:??? -> ?extraConnectionAttributes:??? -> ?status:??? -> ?kmsKeyId:??? -> ?endpointArn:??? -> ?certificateArn:??? -> ?sslMode:??? -> ?serviceAccessRoleArn:??? -> ?externalTableDefinition:??? -> ?externalId:??? -> ?isReadOnly:??? -> ?dynamoDbSettings:??? -> ?s3Settings:??? -> ?dmsTransferSettings:??? -> ?mongoDbSettings:??? -> ?kinesisSettings:??? -> ?kafkaSettings:??? -> ?elasticsearchSettings:??? -> ?neptuneSettings:??? -> ?redshiftSettings:??? -> ?postgreSQLSettings:??? -> ?mySQLSettings:??? -> ?oracleSettings:??? -> ?sybaseSettings:??? -> ?microsoftSQLServerSettings:??? -> ?iBMDb2Settings:??? -> ?docDbSettings:??? -> ?redisSettings:??? -> ?gcpMySQLSettings:??? -> ?timestreamSettings:??? -> ?lakehouseSettings:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of BooleanOptional.t | `Enum of string | `Integer of IntegerOptional.t | `String of String_.t | `Structure of (string * [> `Boolean of BooleanOptional.t | `Enum of string | `Integer of IntegerOptional.t | `List of [> `Integer of Integer.t ] list | `String of String_.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t