/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Provides information that defines a MongoDB endpoint.See
* Also:
AWS
* API Reference
The user name you use to access the MongoDB source endpoint.
*/ inline const Aws::String& GetUsername() const{ return m_username; } /** *The user name you use to access the MongoDB source endpoint.
*/ inline bool UsernameHasBeenSet() const { return m_usernameHasBeenSet; } /** *The user name you use to access the MongoDB source endpoint.
*/ inline void SetUsername(const Aws::String& value) { m_usernameHasBeenSet = true; m_username = value; } /** *The user name you use to access the MongoDB source endpoint.
*/ inline void SetUsername(Aws::String&& value) { m_usernameHasBeenSet = true; m_username = std::move(value); } /** *The user name you use to access the MongoDB source endpoint.
*/ inline void SetUsername(const char* value) { m_usernameHasBeenSet = true; m_username.assign(value); } /** *The user name you use to access the MongoDB source endpoint.
*/ inline MongoDbSettings& WithUsername(const Aws::String& value) { SetUsername(value); return *this;} /** *The user name you use to access the MongoDB source endpoint.
*/ inline MongoDbSettings& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;} /** *The user name you use to access the MongoDB source endpoint.
*/ inline MongoDbSettings& WithUsername(const char* value) { SetUsername(value); return *this;} /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline const Aws::String& GetPassword() const{ return m_password; } /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline bool PasswordHasBeenSet() const { return m_passwordHasBeenSet; } /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline void SetPassword(const Aws::String& value) { m_passwordHasBeenSet = true; m_password = value; } /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline void SetPassword(Aws::String&& value) { m_passwordHasBeenSet = true; m_password = std::move(value); } /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline void SetPassword(const char* value) { m_passwordHasBeenSet = true; m_password.assign(value); } /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline MongoDbSettings& WithPassword(const Aws::String& value) { SetPassword(value); return *this;} /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline MongoDbSettings& WithPassword(Aws::String&& value) { SetPassword(std::move(value)); return *this;} /** *The password for the user account you use to access the MongoDB source * endpoint.
*/ inline MongoDbSettings& WithPassword(const char* value) { SetPassword(value); return *this;} /** *The name of the server on the MongoDB source endpoint.
*/ inline const Aws::String& GetServerName() const{ return m_serverName; } /** *The name of the server on the MongoDB source endpoint.
*/ inline bool ServerNameHasBeenSet() const { return m_serverNameHasBeenSet; } /** *The name of the server on the MongoDB source endpoint.
*/ inline void SetServerName(const Aws::String& value) { m_serverNameHasBeenSet = true; m_serverName = value; } /** *The name of the server on the MongoDB source endpoint.
*/ inline void SetServerName(Aws::String&& value) { m_serverNameHasBeenSet = true; m_serverName = std::move(value); } /** *The name of the server on the MongoDB source endpoint.
*/ inline void SetServerName(const char* value) { m_serverNameHasBeenSet = true; m_serverName.assign(value); } /** *The name of the server on the MongoDB source endpoint.
*/ inline MongoDbSettings& WithServerName(const Aws::String& value) { SetServerName(value); return *this;} /** *The name of the server on the MongoDB source endpoint.
*/ inline MongoDbSettings& WithServerName(Aws::String&& value) { SetServerName(std::move(value)); return *this;} /** *The name of the server on the MongoDB source endpoint.
*/ inline MongoDbSettings& WithServerName(const char* value) { SetServerName(value); return *this;} /** *The port value for the MongoDB source endpoint.
*/ inline int GetPort() const{ return m_port; } /** *The port value for the MongoDB source endpoint.
*/ inline bool PortHasBeenSet() const { return m_portHasBeenSet; } /** *The port value for the MongoDB source endpoint.
*/ inline void SetPort(int value) { m_portHasBeenSet = true; m_port = value; } /** *The port value for the MongoDB source endpoint.
*/ inline MongoDbSettings& WithPort(int value) { SetPort(value); return *this;} /** *The database name on the MongoDB source endpoint.
*/ inline const Aws::String& GetDatabaseName() const{ return m_databaseName; } /** *The database name on the MongoDB source endpoint.
*/ inline bool DatabaseNameHasBeenSet() const { return m_databaseNameHasBeenSet; } /** *The database name on the MongoDB source endpoint.
*/ inline void SetDatabaseName(const Aws::String& value) { m_databaseNameHasBeenSet = true; m_databaseName = value; } /** *The database name on the MongoDB source endpoint.
*/ inline void SetDatabaseName(Aws::String&& value) { m_databaseNameHasBeenSet = true; m_databaseName = std::move(value); } /** *The database name on the MongoDB source endpoint.
*/ inline void SetDatabaseName(const char* value) { m_databaseNameHasBeenSet = true; m_databaseName.assign(value); } /** *The database name on the MongoDB source endpoint.
*/ inline MongoDbSettings& WithDatabaseName(const Aws::String& value) { SetDatabaseName(value); return *this;} /** *The database name on the MongoDB source endpoint.
*/ inline MongoDbSettings& WithDatabaseName(Aws::String&& value) { SetDatabaseName(std::move(value)); return *this;} /** *The database name on the MongoDB source endpoint.
*/ inline MongoDbSettings& WithDatabaseName(const char* value) { SetDatabaseName(value); return *this;} /** *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.
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.
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.
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.
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.
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.
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"
.
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"
.
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"
.
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"
.
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"
.
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"
.
Specifies either document or table mode.
Default value is
* "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
Specifies either document or table mode.
Default value is
* "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
Specifies either document or table mode.
Default value is
* "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
Specifies either document or table mode.
Default value is
* "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
Specifies either document or table mode.
Default value is
* "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
Specifies either document or table mode.
Default value is
* "none"
. Specify "none"
to use document mode. Specify
* "one"
to use table mode.
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
Specifies the document ID. Use this setting when NestingLevel
* is set to "none"
.
Default value is "false"
.
*
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
The MongoDB database name. This setting isn't used when
* AuthType
is set to "no"
.
The default is
* "admin"
.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
The full ARN, partial ARN, or friendly name of the
* SecretsManagerSecret
that contains the MongoDB endpoint connection
* details.
If true
, DMS retrieves the entire document from the MongoDB
* source during migration. This may cause a migration failure if the server
* response exceeds bandwidth limits. To fetch only updates and deletes during
* migration, set this parameter to false
.
If true
, DMS retrieves the entire document from the MongoDB
* source during migration. This may cause a migration failure if the server
* response exceeds bandwidth limits. To fetch only updates and deletes during
* migration, set this parameter to false
.
If true
, DMS retrieves the entire document from the MongoDB
* source during migration. This may cause a migration failure if the server
* response exceeds bandwidth limits. To fetch only updates and deletes during
* migration, set this parameter to false
.
If true
, DMS retrieves the entire document from the MongoDB
* source during migration. This may cause a migration failure if the server
* response exceeds bandwidth limits. To fetch only updates and deletes during
* migration, set this parameter to false
.
If true
, DMS replicates data to shard collections. DMS only uses
* this setting if the target endpoint is a DocumentDB elastic cluster.
When
* this setting is true
, note the following:
You must
* set TargetTablePrepMode
to nothing
.
DMS automatically sets useUpdateLookup
to
* false
.
If true
, DMS replicates data to shard collections. DMS only uses
* this setting if the target endpoint is a DocumentDB elastic cluster.
When
* this setting is true
, note the following:
You must
* set TargetTablePrepMode
to nothing
.
DMS automatically sets useUpdateLookup
to
* false
.
If true
, DMS replicates data to shard collections. DMS only uses
* this setting if the target endpoint is a DocumentDB elastic cluster.
When
* this setting is true
, note the following:
You must
* set TargetTablePrepMode
to nothing
.
DMS automatically sets useUpdateLookup
to
* false
.
If true
, DMS replicates data to shard collections. DMS only uses
* this setting if the target endpoint is a DocumentDB elastic cluster.
When
* this setting is true
, note the following:
You must
* set TargetTablePrepMode
to nothing
.
DMS automatically sets useUpdateLookup
to
* false
.