databasemigrationservice/aws.sdk.kotlin.services.databasemigrationservice.model/DocDbSettings/Builder

Builder

Properties

The database name on the DocumentDB source endpoint.

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

extractDocId

var extractDocId: Boolean?

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

kmsKeyId

var kmsKeyId: String?

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.

nestingLevel

var nestingLevel: NestingLevelValue?

Specifies either document or table mode.

password

var password: String?

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

port

var port: Int?

The port value for the DocumentDB source endpoint.

replicateShardCollections

var replicateShardCollections: Boolean?

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

secretsManagerAccessRoleArn

var secretsManagerAccessRoleArn: String?

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 DocumentDB endpoint.

secretsManagerSecretId

var secretsManagerSecretId: String?

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

serverName

var serverName: String?

The name of the server on the DocumentDB source endpoint.

username

var username: String?

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

useUpdateLookUp

var useUpdateLookUp: Boolean?

If true, DMS retrieves the entire document from the DocumentDB 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.