You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DatabaseMigrationService::Types::MongoDbSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing MongoDbSettings as input to an Aws::Client method, you can use a vanilla 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",
}

Provides information that defines a MongoDB endpoint.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auth_mechanism ⇒ String

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".

Possible values:

  • default
  • mongodb_cr
  • scram_sha_1

Returns:

  • (String) —

    The authentication mechanism you use to access the MongoDB source endpoint.

#auth_source ⇒ String

The MongoDB database name. This setting isn\'t used when AuthType is set to "no".

The default is "admin".

Returns:

  • (String) —

    The MongoDB database name.

#auth_type ⇒ String

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.

Possible values:

  • no
  • password

Returns:

  • (String) —

    The authentication type you use to access the MongoDB source endpoint.

#database_name ⇒ String

The database name on the MongoDB source endpoint.

Returns:

  • (String) —

    The database name on the MongoDB source endpoint.

#docs_to_investigate ⇒ String

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:

  • (String) —

    Indicates the number of documents to preview to determine the document organization.

#extract_doc_id ⇒ String

Specifies the document ID. Use this setting when NestingLevel is set to "none".

Default value is "false".

Returns:

  • (String) —

    Specifies the document ID.

#kms_key_id ⇒ String

The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Returns:

  • (String) —

    The AWS KMS key identifier that is used to encrypt the content on the replication instance.

#nesting_level ⇒ String

Specifies either document or table mode.

Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.

Possible values:

  • none
  • one

Returns:

  • (String) —

    Specifies either document or table mode.

#password ⇒ String

The password for the user account you use to access the MongoDB source endpoint.

Returns:

  • (String) —

    The password for the user account you use to access the MongoDB source endpoint.

#port ⇒ Integer

The port value for the MongoDB source endpoint.

Returns:

  • (Integer) —

    The port value for the MongoDB source endpoint.

#server_name ⇒ String

The name of the server on the MongoDB source endpoint.

Returns:

  • (String) —

    The name of the server on the MongoDB source endpoint.

#username ⇒ String

The user name you use to access the MongoDB source endpoint.

Returns:

  • (String) —

    The user name you use to access the MongoDB source endpoint.