class Aws::DatabaseMigrationService::Types::MongoDbSettings
Provides information that defines a MongoDB endpoint.
@note When making an API call, you may pass MongoDbSettings
data as a hash: { username: "String", password: "SecretString", server_name: "String", port: 1, database_name: "String", auth_type: "no", # accepts no, password auth_mechanism: "default", # accepts default, mongodb_cr, scram_sha_1 nesting_level: "none", # accepts none, one extract_doc_id: "String", docs_to_investigate: "String", auth_source: "String", kms_key_id: "String", secrets_manager_access_role_arn: "String", secrets_manager_secret_id: "String", }
@!attribute [rw] username
The user name you use to access the MongoDB source endpoint. @return [String]
@!attribute [rw] password
The password for the user account you use to access the MongoDB source endpoint. @return [String]
@!attribute [rw] server_name
The name of the server on the MongoDB source endpoint. @return [String]
@!attribute [rw] port
The port value for the MongoDB source endpoint. @return [Integer]
@!attribute [rw] database_name
The database name on the MongoDB source endpoint. @return [String]
@!attribute [rw] auth_type
The authentication type you use to access the MongoDB source endpoint. When when set to `"no"`, user name and password parameters are not used and can be empty. @return [String]
@!attribute [rw] auth_mechanism
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"`. @return [String]
@!attribute [rw] nesting_level
Specifies either document or table mode. Default value is `"none"`. Specify `"none"` to use document mode. Specify `"one"` to use table mode. @return [String]
@!attribute [rw] extract_doc_id
Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"`. Default value is `"false"`. @return [String]
@!attribute [rw] docs_to_investigate
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`. @return [String]
@!attribute [rw] auth_source
The MongoDB database name. This setting isn't used when `AuthType` is set to `"no"`. The default is `"admin"`. @return [String]
@!attribute [rw] kms_key_id
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. @return [String]
@!attribute [rw] secrets_manager_access_role_arn
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 MongoDB endpoint. <note markdown="1"> 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][1] in the *Database Migration Service User Guide*. </note> [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager @return [String]
@!attribute [rw] secrets_manager_secret_id
The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/MongoDbSettings AWS API Documentation
Constants
- SENSITIVE