Interface DocDbSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DocDbSettings.Builder,
,DocDbSettings> SdkBuilder<DocDbSettings.Builder,
,DocDbSettings> SdkPojo
- Enclosing class:
DocDbSettings
-
Method Summary
Modifier and TypeMethodDescriptiondatabaseName
(String databaseName) The database name on the DocumentDB source endpoint.docsToInvestigate
(Integer docsToInvestigate) Indicates the number of documents to preview to determine the document organization.extractDocId
(Boolean extractDocId) Specifies the document ID.The KMS key identifier that is used to encrypt the content on the replication instance.nestingLevel
(String nestingLevel) Specifies either document or table mode.nestingLevel
(NestingLevelValue nestingLevel) Specifies either document or table mode.The password for the user account you use to access the DocumentDB source endpoint.The port value for the DocumentDB source endpoint.replicateShardCollections
(Boolean replicateShardCollections) Iftrue
, DMS replicates data to shard collections.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 inSecretsManagerSecret
.secretsManagerSecretId
(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of theSecretsManagerSecret
that contains the DocumentDB endpoint connection details.serverName
(String serverName) The name of the server on the DocumentDB source endpoint.The user name you use to access the DocumentDB source endpoint.useUpdateLookUp
(Boolean useUpdateLookUp) Iftrue
, DMS retrieves the entire document from the DocumentDB source during migration.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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:
-
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:
-
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 whenNestingLevel
is set to"none"
.Default value is
"false"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 is1000
.- Parameters:
docsToInvestigate
- Indicates the number of documents to preview to determine the document organization. Use this setting whenNestingLevel
is set to"one"
.Must be a positive value greater than
0
. Default value is1000
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theKmsKeyId
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
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 theiam: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 forUserName
,Password
,ServerName
, andPort
. You can't specify both. For more information on creating thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
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 inSecretsManagerSecret
. The role must allow theiam: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 forUserName
,Password
,ServerName
, andPort
. You can't specify both. For more information on creating thisSecretsManagerSecret
and theSecretsManagerAccessRoleArn
andSecretsManagerSecretId
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
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 theSecretsManagerSecret
that contains the DocumentDB endpoint connection details.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 tofalse
.- Parameters:
useUpdateLookUp
- Iftrue
, 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 tofalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
tonothing
. -
DMS automatically sets
useUpdateLookup
tofalse
.
- Parameters:
replicateShardCollections
- Iftrue
, 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
tonothing
. -
DMS automatically sets
useUpdateLookup
tofalse
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-