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

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

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.

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#auth_sourceString

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

The default is admin.

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

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

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#database_nameString

The database name on the MongoDB source endpoint.

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#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)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#extract_doc_idString

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

Default value is false.

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

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

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#passwordString

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

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#portInteger

The port value for the MongoDB source endpoint.

Returns:

  • (Integer)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#server_nameString

The name of the server on the MongoDB source endpoint.

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2825

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)
  include Aws::Structure
end