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

Class: Aws::DatabaseMigrationService::Types::DocDbSettings

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

Overview

Note:

When passing DocDbSettings 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",
  nesting_level: "none", # accepts none, one
  extract_doc_id: false,
  docs_to_investigate: 1,
  kms_key_id: "String",
}

Provides information that defines a DocumentDB endpoint.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#database_name ⇒ String

The database name on the DocumentDB source endpoint.

Returns:

  • (String) —

    The database name on the DocumentDB source endpoint.

#docs_to_investigate ⇒ Integer

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:

  • (Integer) —

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

#extract_doc_id ⇒ Boolean

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

Default value is "false".

Returns:

  • (Boolean) —

    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 DocumentDB source endpoint.

Returns:

  • (String) —

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

#port ⇒ Integer

The port value for the DocumentDB source endpoint.

Returns:

  • (Integer) —

    The port value for the DocumentDB source endpoint.

#server_name ⇒ String

The name of the server on the DocumentDB source endpoint.

Returns:

  • (String) —

    The name of the server on the DocumentDB source endpoint.

#username ⇒ String

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

Returns:

  • (String) —

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