Class DocDbSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocDbSettings.Builder,
DocDbSettings>
Provides information that defines a DocumentDB endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DocDbSettings.Builder
builder()
final String
The database name on the DocumentDB source endpoint.final Integer
Indicates the number of documents to preview to determine the document organization.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Specifies the document ID.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
kmsKeyId()
The KMS key identifier that is used to encrypt the content on the replication instance.final NestingLevelValue
Specifies either document or table mode.final String
Specifies either document or table mode.final String
password()
The password for the user account you use to access the DocumentDB source endpoint.final Integer
port()
The port value for the DocumentDB source endpoint.final Boolean
Iftrue
, DMS replicates data to shard collections.final 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 inSecretsManagerSecret
.final String
The full ARN, partial ARN, or friendly name of theSecretsManagerSecret
that contains the DocumentDB endpoint connection details.static Class
<? extends DocDbSettings.Builder> final String
The name of the server on the DocumentDB source endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
username()
The user name you use to access the DocumentDB source endpoint.final Boolean
Iftrue
, DMS retrieves the entire document from the DocumentDB source during migration.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
username
The user name you use to access the DocumentDB source endpoint.
- Returns:
- The user name you use to access the DocumentDB source endpoint.
-
password
The password for the user account you use to access the DocumentDB source endpoint.
- Returns:
- The password for the user account you use to access the DocumentDB source endpoint.
-
serverName
The name of the server on the DocumentDB source endpoint.
- Returns:
- The name of the server on the DocumentDB source endpoint.
-
port
The port value for the DocumentDB source endpoint.
- Returns:
- The port value for the DocumentDB source endpoint.
-
databaseName
The database name on the DocumentDB source endpoint.
- Returns:
- The database name on the DocumentDB source endpoint.
-
nestingLevel
Specifies either document or table mode.
Default value is
"none"
. Specify"none"
to use document mode. Specify"one"
to use table mode.If the service returns an enum value that is not available in the current SDK version,
nestingLevel
will returnNestingLevelValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnestingLevelAsString()
.- Returns:
- Specifies either document or table mode.
Default value is
"none"
. Specify"none"
to use document mode. Specify"one"
to use table mode. - See Also:
-
nestingLevelAsString
Specifies either document or table mode.
Default value is
"none"
. Specify"none"
to use document mode. Specify"one"
to use table mode.If the service returns an enum value that is not available in the current SDK version,
nestingLevel
will returnNestingLevelValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnestingLevelAsString()
.- Returns:
- Specifies either document or table mode.
Default value is
"none"
. Specify"none"
to use document mode. Specify"one"
to use table mode. - See Also:
-
extractDocId
Specifies the document ID. Use this setting when
NestingLevel
is set to"none"
.Default value is
"false"
.- Returns:
- Specifies the document ID. Use this setting when
NestingLevel
is set to"none"
.Default value is
"false"
.
-
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
.- Returns:
- 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
.
-
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:
- 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.
-
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.- Returns:
- 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.
-
secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the DocumentDB endpoint connection details.- Returns:
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the DocumentDB endpoint connection details.
-
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
.- Returns:
- 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
.
-
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
.
- Returns:
- 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
.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DocDbSettings.Builder,
DocDbSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-