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

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::MongoDbSettings

Defined in:

gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Provides information that defines a MongoDB endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #auth_mechanism ⇒ String

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

• #auth_source ⇒ String

  The MongoDB database name.

• #auth_type ⇒ String

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

• #database_name ⇒ 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.

• #extract_doc_id ⇒ String

  Specifies the document ID.

• #kms_key_id ⇒ String

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

• #nesting_level ⇒ String

  Specifies either document or table mode.

• #password ⇒ 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.

• #secrets_manager_access_role_arn ⇒ String

  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.

• #secrets_manager_secret_id ⇒ String

  The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.

• #server_name ⇒ String

  The name of the server on the MongoDB source endpoint.

• #username ⇒ String

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

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#auth_source ⇒ String

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

The default is "admin".

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#database_name ⇒ String

The database name on the MongoDB source endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

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

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#extract_doc_id ⇒ String

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

Default value is "false".

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kms_key_id ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#password ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#port ⇒ Integer

The port value for the MongoDB source endpoint.

Returns:

• (Integer)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_access_role_arn ⇒ String

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.

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 in the Database Migration Service User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#secrets_manager_secret_id ⇒ String

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_name ⇒ String

The name of the server on the MongoDB source endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end

#username ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 5734

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,
  :secrets_manager_access_role_arn,
  :secrets_manager_secret_id)
  SENSITIVE = [:password]
  include Aws::Structure
end