DocDbSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.DocDbSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocDbSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that defines a DocumentDB endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocDbSettings()

Constructors
Constructor and Description
`DocDbSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocDbSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDatabaseName()` The database name on the DocumentDB source endpoint.
`Integer`	`getDocsToInvestigate()` Indicates the number of documents to preview to determine the document organization.
`Boolean`	`getExtractDocId()` Specifies the document ID.
`String`	`getKmsKeyId()` The KMS key identifier that is used to encrypt the content on the replication instance.
`String`	`getNestingLevel()` Specifies either document or table mode.
`String`	`getPassword()` The password for the user account you use to access the DocumentDB source endpoint.
`Integer`	`getPort()` The port value for the DocumentDB source endpoint.
`String`	`getSecretsManagerAccessRoleArn()` 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`.
`String`	`getSecretsManagerSecretId()` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details.
`String`	`getServerName()` The name of the server on the DocumentDB source endpoint.
`String`	`getUsername()` The user name you use to access the DocumentDB source endpoint.
`int`	`hashCode()`
`Boolean`	`isExtractDocId()` Specifies the document ID.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDatabaseName(String databaseName)` The database name on the DocumentDB source endpoint.
`void`	`setDocsToInvestigate(Integer docsToInvestigate)` Indicates the number of documents to preview to determine the document organization.
`void`	`setExtractDocId(Boolean extractDocId)` Specifies the document ID.
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier that is used to encrypt the content on the replication instance.
`void`	`setNestingLevel(String nestingLevel)` Specifies either document or table mode.
`void`	`setPassword(String password)` The password for the user account you use to access the DocumentDB source endpoint.
`void`	`setPort(Integer port)` The port value for the DocumentDB source endpoint.
`void`	`setSecretsManagerAccessRoleArn(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`.
`void`	`setSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details.
`void`	`setServerName(String serverName)` The name of the server on the DocumentDB source endpoint.
`void`	`setUsername(String username)` The user name you use to access the DocumentDB source endpoint.
`String`	`toString()` Returns a string representation of this object.
`DocDbSettings`	`withDatabaseName(String databaseName)` The database name on the DocumentDB source endpoint.
`DocDbSettings`	`withDocsToInvestigate(Integer docsToInvestigate)` Indicates the number of documents to preview to determine the document organization.
`DocDbSettings`	`withExtractDocId(Boolean extractDocId)` Specifies the document ID.
`DocDbSettings`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier that is used to encrypt the content on the replication instance.
`DocDbSettings`	`withNestingLevel(NestingLevelValue nestingLevel)` Specifies either document or table mode.
`DocDbSettings`	`withNestingLevel(String nestingLevel)` Specifies either document or table mode.
`DocDbSettings`	`withPassword(String password)` The password for the user account you use to access the DocumentDB source endpoint.
`DocDbSettings`	`withPort(Integer port)` The port value for the DocumentDB source endpoint.
`DocDbSettings`	`withSecretsManagerAccessRoleArn(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`	`withSecretsManagerSecretId(String secretsManagerSecretId)` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details.
`DocDbSettings`	`withServerName(String serverName)` The name of the server on the DocumentDB source endpoint.
`DocDbSettings`	`withUsername(String username)` The user name you use to access the DocumentDB source endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocDbSettings
```
public DocDbSettings()
```
- Method Detail
  - setUsername
```
public void setUsername(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.
  - getUsername
```
public String getUsername()
```
    The user name you use to access the DocumentDB source endpoint.
    
    Returns:
    
    The user name you use to access the DocumentDB source endpoint.
  - withUsername
```
public DocDbSettings withUsername(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.
  - setPassword
```
public void setPassword(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.
  - getPassword
```
public String getPassword()
```
    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.
  - withPassword
```
public DocDbSettings withPassword(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.
  - setServerName
```
public void setServerName(String serverName)
```
    The name of the server on the DocumentDB source endpoint.
    
    Parameters:
    
    serverName - The name of the server on the DocumentDB source endpoint.
  - getServerName
```
public String getServerName()
```
    The name of the server on the DocumentDB source endpoint.
    
    Returns:
    
    The name of the server on the DocumentDB source endpoint.
  - withServerName
```
public DocDbSettings withServerName(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.
  - setPort
```
public void setPort(Integer port)
```
    The port value for the DocumentDB source endpoint.
    
    Parameters:
    
    port - The port value for the DocumentDB source endpoint.
  - getPort
```
public Integer getPort()
```
    The port value for the DocumentDB source endpoint.
    
    Returns:
    
    The port value for the DocumentDB source endpoint.
  - withPort
```
public DocDbSettings withPort(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.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The database name on the DocumentDB source endpoint.
    
    Parameters:
    
    databaseName - The database name on the DocumentDB source endpoint.
  - getDatabaseName
```
public String getDatabaseName()
```
    The database name on the DocumentDB source endpoint.
    
    Returns:
    
    The database name on the DocumentDB source endpoint.
  - withDatabaseName
```
public DocDbSettings withDatabaseName(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.
  - setNestingLevel
```
public void setNestingLevel(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.
    
    See Also:
    
    NestingLevelValue
  - getNestingLevel
```
public String getNestingLevel()
```
    Specifies either document or table mode.
    
    Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.
    
    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:
    
    NestingLevelValue
  - withNestingLevel
```
public DocDbSettings withNestingLevel(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
  - withNestingLevel
```
public DocDbSettings withNestingLevel(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
  - setExtractDocId
```
public void setExtractDocId(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".
  - getExtractDocId
```
public Boolean getExtractDocId()
```
    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".
  - withExtractDocId
```
public DocDbSettings withExtractDocId(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.
  - isExtractDocId
```
public Boolean isExtractDocId()
```
    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".
  - setDocsToInvestigate
```
public void setDocsToInvestigate(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.
  - getDocsToInvestigate
```
public Integer getDocsToInvestigate()
```
    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:
    
    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.
  - withDocsToInvestigate
```
public DocDbSettings withDocsToInvestigate(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.
  - setKmsKeyId
```
public void setKmsKeyId(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.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    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.
  - withKmsKeyId
```
public DocDbSettings withKmsKeyId(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.
  - setSecretsManagerAccessRoleArn
```
public void setSecretsManagerAccessRoleArn(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.
  - getSecretsManagerAccessRoleArn
```
public String getSecretsManagerAccessRoleArn()
```
    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:
    
    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.
  - withSecretsManagerAccessRoleArn
```
public DocDbSettings withSecretsManagerAccessRoleArn(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.
  - setSecretsManagerSecretId
```
public void setSecretsManagerSecretId(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.
  - getSecretsManagerSecretId
```
public String getSecretsManagerSecretId()
```
    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.
  - withSecretsManagerSecretId
```
public DocDbSettings withSecretsManagerSecretId(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.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocDbSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DocDbSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocDbSettings

Method Detail

setUsername

getUsername

withUsername

setPassword

getPassword

withPassword

setServerName

getServerName

withServerName

setPort

getPort

withPort

setDatabaseName

getDatabaseName

withDatabaseName

setNestingLevel

getNestingLevel

withNestingLevel

withNestingLevel

setExtractDocId

getExtractDocId

withExtractDocId

isExtractDocId

setDocsToInvestigate

getDocsToInvestigate

withDocsToInvestigate

setKmsKeyId

getKmsKeyId

withKmsKeyId

setSecretsManagerAccessRoleArn

getSecretsManagerAccessRoleArn

withSecretsManagerAccessRoleArn

setSecretsManagerSecretId

getSecretsManagerSecretId

withSecretsManagerSecretId

toString

equals

hashCode

clone

marshall