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",
}

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#auth_mechanismString

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

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

Possible values:

  • default
  • mongodb_cr
  • scram_sha_1

Returns:

  • (String)

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

#auth_sourceString

The MongoDB database name. This attribute is not used when authType=NO.

The default is admin.

Returns:

  • (String)

    The MongoDB database name.

#auth_typeString

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

Valid values: NO, PASSWORD

When NO is selected, 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_nameString

The database name on the MongoDB source endpoint.

Returns:

  • (String)

    The database name on the MongoDB source endpoint.

#docs_to_investigateString

Indicates the number of documents to preview to determine the document organization. Use this attribute 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_idString

Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

Default value is false.

Returns:

  • (String)

    Specifies the document ID.

#nesting_levelString

Specifies either document or table mode.

Valid values: NONE, ONE

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.

#passwordString

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.

#portInteger

The port value for the MongoDB source endpoint.

Returns:

  • (Integer)

    The port value for the MongoDB source endpoint.

#server_nameString

The name of the server on the MongoDB source endpoint.

Returns:

  • (String)

    The name of the server on the MongoDB source endpoint.

#usernameString

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

Returns:

  • (String)

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