DocDbSettings - AWS Database Migration Service
ContentsSee Also

DocDbSettings

Provides information that defines a DocumentDB endpoint.

Contents

DatabaseName

The database name on the DocumentDB source endpoint.

Type: String

Required: No

DocsToInvestigate

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

Must be a positive value greater than 0. Default value is 1000.

Type: Integer

Required: No

ExtractDocId

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

Default value is "false".

Type: Boolean

Required: No

KmsKeyId

The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Type: String

Required: No

NestingLevel

Specifies either document or table mode.

Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.

Type: String

Valid Values: none | one

Required: No

Password

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

Type: String

Required: No

Port

The port value for the DocumentDB source endpoint.

Type: Integer

Required: No

ReplicateShardCollections

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

When this setting is true, note the following:

  • You must set TargetTablePrepMode to nothing.

  • AWS DMS automatically sets useUpdateLookup to false.

Type: Boolean

Required: No

SecretsManagerAccessRoleArn

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.

Note

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

Type: String

Required: No

SecretsManagerSecretId

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

Type: String

Required: No

ServerName

The name of the server on the DocumentDB source endpoint.

Type: String

Required: No

Username

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

Type: String

Required: No

UseUpdateLookUp

If true, AWS 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.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: