MongoDbSettings

Provides information that defines a MongoDB endpoint.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The authentication mechanism you use to access the MongoDB source endpoint.

Link copied to clipboard

The MongoDB database name. This setting isn't used when AuthType is set to "no".

Link copied to clipboard

The authentication type you use to access the MongoDB source endpoint.

Link copied to clipboard

The database name on the MongoDB source endpoint.

Link copied to clipboard

Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".

Link copied to clipboard

Specifies the document ID. Use this setting when NestingLevel is set to "none".

Link copied to clipboard

The KMS key identifier that is used to encrypt the content on the replication instance. 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.

Link copied to clipboard

Specifies either document or table mode.

Link copied to clipboard

The password for the user account you use to access the MongoDB source endpoint.

Link copied to clipboard
val port: Int?

The port value for the MongoDB source endpoint.

Link copied to clipboard

If true, DMS replicates data to shard collections. DMS only uses this setting if the target endpoint is a DocumentDB elastic cluster.

Link copied to clipboard

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.

Link copied to clipboard

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.

Link copied to clipboard

The name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the server name for any of the servers in the replication set.

Link copied to clipboard

The user name you use to access the MongoDB source endpoint.

Link copied to clipboard

If true, DMS retrieves the entire document from the MongoDB source during migration. This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates and deletes during migration, set this parameter to false.

Functions

Link copied to clipboard
inline fun copy(block: MongoDbSettings.Builder.() -> Unit = {}): MongoDbSettings
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String