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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

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

Provides information that defines a MongoDB endpoint.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_mechanismString

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

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#auth_sourceString

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

The default is "admin".

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#auth_typeString

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.

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_nameString

The database name on the MongoDB source endpoint.

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#docs_to_investigateString

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)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#extract_doc_idString

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

Default value is "false".

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kms_key_idString

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)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#nesting_levelString

Specifies either document or table mode.

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

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

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

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#portInteger

The port value for the MongoDB source endpoint.

Returns:

  • (Integer)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_nameString

The name of the server on the MongoDB source endpoint.

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5292

class MongoDbSettings < Struct.new(
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :auth_type,
  :auth_mechanism,
  :nesting_level,
  :extract_doc_id,
  :docs_to_investigate,
  :auth_source,
  :kms_key_id)
  SENSITIVE = [:password]
  include Aws::Structure
end