software.amazon.awssdk.services.databasemigration.model

Interface DocDbSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DocDbSettings.Builder,DocDbSettings>, SdkBuilder<DocDbSettings.Builder,DocDbSettings>, SdkPojo

Enclosing class:

DocDbSettings

public static interface DocDbSettings.Builder
extends SdkPojo, CopyableBuilder<DocDbSettings.Builder,DocDbSettings>

Method Summary

Modifier and Type	Method and Description
DocDbSettings.Builder	databaseName(String databaseName) The database name on the DocumentDB source endpoint.
DocDbSettings.Builder	docsToInvestigate(Integer docsToInvestigate) Indicates the number of documents to preview to determine the document organization.
DocDbSettings.Builder	extractDocId(Boolean extractDocId) Specifies the document ID.
DocDbSettings.Builder	kmsKeyId(String kmsKeyId) The KMS key identifier that is used to encrypt the content on the replication instance.
DocDbSettings.Builder	nestingLevel(NestingLevelValue nestingLevel) Specifies either document or table mode.
DocDbSettings.Builder	nestingLevel(String nestingLevel) Specifies either document or table mode.
DocDbSettings.Builder	password(String password) The password for the user account you use to access the DocumentDB source endpoint.
DocDbSettings.Builder	port(Integer port) The port value for the DocumentDB source endpoint.
DocDbSettings.Builder	replicateShardCollections(Boolean replicateShardCollections) If true, DMS replicates data to shard collections.
DocDbSettings.Builder	secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) 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.
DocDbSettings.Builder	secretsManagerSecretId(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
DocDbSettings.Builder	serverName(String serverName) The name of the server on the DocumentDB source endpoint.
DocDbSettings.Builder	username(String username) The user name you use to access the DocumentDB source endpoint.
DocDbSettings.Builder	useUpdateLookUp(Boolean useUpdateLookUp) If true, DMS retrieves the entire document from the DocumentDB source during migration.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

username

DocDbSettings.Builder username(String username)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

password

DocDbSettings.Builder password(String password)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

DocDbSettings.Builder serverName(String serverName)

The name of the server on the DocumentDB source endpoint.

Parameters:

serverName - The name of the server on the DocumentDB source endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

port

DocDbSettings.Builder port(Integer port)

The port value for the DocumentDB source endpoint.

Parameters:

port - The port value for the DocumentDB source endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseName

DocDbSettings.Builder databaseName(String databaseName)

The database name on the DocumentDB source endpoint.

Parameters:

databaseName - The database name on the DocumentDB source endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

nestingLevel

DocDbSettings.Builder nestingLevel(String nestingLevel)

Specifies either document or table mode.

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

Parameters:

nestingLevel - Specifies either document or table mode.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NestingLevelValue, NestingLevelValue

nestingLevel

DocDbSettings.Builder nestingLevel(NestingLevelValue nestingLevel)

Specifies either document or table mode.

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

Parameters:

nestingLevel - Specifies either document or table mode.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NestingLevelValue, NestingLevelValue

extractDocId

DocDbSettings.Builder extractDocId(Boolean extractDocId)

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

Default value is "false".

Parameters:

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

Default value is "false".

Returns:

Returns a reference to this object so that method calls can be chained together.

docsToInvestigate

DocDbSettings.Builder docsToInvestigate(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

DocDbSettings.Builder kmsKeyId(String kmsKeyId)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerAccessRoleArn

DocDbSettings.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)

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.

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 Database Migration Service resources in the Database Migration Service User Guide.

Parameters:

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

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 Database Migration Service resources in the Database Migration Service User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerSecretId

DocDbSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

useUpdateLookUp

DocDbSettings.Builder useUpdateLookUp(Boolean useUpdateLookUp)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

replicateShardCollections

DocDbSettings.Builder replicateShardCollections(Boolean replicateShardCollections)

If true, DMS replicates data to shard collections. 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.

• DMS automatically sets useUpdateLookup to false.

Parameters:

replicateShardCollections - If true, DMS replicates data to shard collections. 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.

• DMS automatically sets useUpdateLookup to false.

Returns:

Returns a reference to this object so that method calls can be chained together.