NAME

Paws::DMS::MongoDbSettings

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::DMS::MongoDbSettings object:

  $service_obj->Method(Att1 => { AuthMechanism => $value, ..., Username => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::MongoDbSettings object:

  $result = $service_obj->Method(...);
  $result->Att1->AuthMechanism

DESCRIPTION

Provides information that defines a MongoDB endpoint.

ATTRIBUTES

AuthMechanism => Str

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

AuthSource => Str

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

The default is "admin".

AuthType => Str

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.

DatabaseName => Str

The database name on the MongoDB source endpoint.

DocsToInvestigate => Str

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.

ExtractDocId => Str

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

Default value is "false".

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.

NestingLevel => Str

Specifies either document or table mode.

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

Password => Str

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

Port => Int

The port value for the MongoDB source endpoint.

SecretsManagerAccessRoleArn => Str

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in "SecretsManagerSecret". "SecretsManagerSecret" has the value of the AWS 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 AWS Database Migration Service resources (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>