CfnEndpoint.MongoDbSettingsProperty

All Known Implementing Classes:: CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy

Enclosing class:: CfnEndpoint

public static interface CfnEndpoint.MongoDbSettingsProperty

Provides information that defines a MongoDB endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see Endpoint configuration settings when using MongoDB as a source for AWS DMS in the AWS Database Migration Service User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 MongoDbSettingsProperty mongoDbSettingsProperty = MongoDbSettingsProperty.builder()
         .authMechanism("authMechanism")
         .authSource("authSource")
         .authType("authType")
         .databaseName("databaseName")
         .docsToInvestigate("docsToInvestigate")
         .extractDocId("extractDocId")
         .nestingLevel("nestingLevel")
         .password("password")
         .port(123)
         .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
         .secretsManagerSecretId("secretsManagerSecretId")
         .serverName("serverName")
         .username("username")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnEndpoint.MongoDbSettingsProperty.Builder` A builder for `CfnEndpoint.MongoDbSettingsProperty`
`static class`	`CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy` An implementation for `CfnEndpoint.MongoDbSettingsProperty`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnEndpoint.MongoDbSettingsProperty.Builder`	`builder()`
`default java.lang.String`	`getAuthMechanism()` The authentication mechanism you use to access the MongoDB source endpoint.
`default java.lang.String`	`getAuthSource()` The MongoDB database name.
`default java.lang.String`	`getAuthType()` The authentication type you use to access the MongoDB source endpoint.
`default java.lang.String`	`getDatabaseName()` The database name on the MongoDB source endpoint.
`default java.lang.String`	`getDocsToInvestigate()` Indicates the number of documents to preview to determine the document organization.
`default java.lang.String`	`getExtractDocId()` Specifies the document ID.
`default java.lang.String`	`getNestingLevel()` Specifies either document or table mode.
`default java.lang.String`	`getPassword()` The password for the user account you use to access the MongoDB source endpoint.
`default java.lang.Number`	`getPort()` The port value for the MongoDB source endpoint.
`default java.lang.String`	`getSecretsManagerAccessRoleArn()` 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` .
`default java.lang.String`	`getSecretsManagerSecretId()` The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details.
`default java.lang.String`	`getServerName()` The name of the server on the MongoDB source endpoint.
`default java.lang.String`	`getUsername()` The user name you use to access the MongoDB source endpoint.

- Method Detail
  - getAuthMechanism
```
default java.lang.String getAuthMechanism()
```
    The authentication mechanism you use to access the MongoDB source endpoint.
    For the default value, in MongoDB version 2.x, "default" is "mongodb_cr" . For MongoDB version 3.x or later, "default" is "scram_sha_1" . This setting isn't used when AuthType is set to "no" .
  - getAuthSource
```
default java.lang.String getAuthSource()
```
    The MongoDB database name. This setting isn't used when `AuthType` is set to `"no"` .
    The default is "admin" .
  - getAuthType
```
default java.lang.String getAuthType()
```
    The authentication type you use to access the MongoDB source endpoint.
    When set to "no" , user name and password parameters are not used and can be empty.
  - getDatabaseName
```
default java.lang.String getDatabaseName()
```
    The database name on the MongoDB source endpoint.
  - getDocsToInvestigate
```
default java.lang.String 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 .
  - getExtractDocId
```
default java.lang.String getExtractDocId()
```
    Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"` .
    Default value is "false" .
  - getNestingLevel
```
default java.lang.String getNestingLevel()
```
    Specifies either document or table mode.
    Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.
  - getPassword
```
default java.lang.String getPassword()
```
    The password for the user account you use to access the MongoDB source endpoint.
  - getPort
```
default java.lang.Number getPort()
```
    The port value for the MongoDB source endpoint.
  - getSecretsManagerAccessRoleArn
```
default java.lang.String getSecretsManagerAccessRoleArn()
```
    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 MongoDB 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 , the corresponding SecretsManagerAccessRoleArn , and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
  - getSecretsManagerSecretId
```
default java.lang.String getSecretsManagerSecretId()
```
    The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details.
  - getServerName
```
default java.lang.String getServerName()
```
    The name of the server on the MongoDB source endpoint.
  - getUsername
```
default java.lang.String getUsername()
```
    The user name you use to access the MongoDB source endpoint.
  - builder
```
static CfnEndpoint.MongoDbSettingsProperty.Builder builder()
```
    Returns:
    
    a CfnEndpoint.MongoDbSettingsProperty.Builder of CfnEndpoint.MongoDbSettingsProperty

Interface CfnEndpoint.MongoDbSettingsProperty

Nested Class Summary

Method Summary

Method Detail

getAuthMechanism

getAuthSource

getAuthType

getDatabaseName

getDocsToInvestigate

getExtractDocId

getNestingLevel

getPassword

getPort

getSecretsManagerAccessRoleArn

getSecretsManagerSecretId

getServerName

getUsername

builder