Struct aws_sdk_databasemigration::model::MongoDbSettings
source · #[non_exhaustive]pub struct MongoDbSettings { /* private fields */ }Expand description
Provides information that defines a MongoDB endpoint.
Implementations§
source§impl MongoDbSettings
impl MongoDbSettings
sourcepub fn username(&self) -> Option<&str>
pub fn username(&self) -> Option<&str>
The user name you use to access the MongoDB source endpoint.
sourcepub fn password(&self) -> Option<&str>
pub fn password(&self) -> Option<&str>
The password for the user account you use to access the MongoDB source endpoint.
sourcepub fn server_name(&self) -> Option<&str>
pub fn server_name(&self) -> Option<&str>
The name of the server on the MongoDB source endpoint.
sourcepub fn database_name(&self) -> Option<&str>
pub fn database_name(&self) -> Option<&str>
The database name on the MongoDB source endpoint.
sourcepub fn auth_type(&self) -> Option<&AuthTypeValue>
pub fn auth_type(&self) -> Option<&AuthTypeValue>
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.
sourcepub fn auth_mechanism(&self) -> Option<&AuthMechanismValue>
pub fn auth_mechanism(&self) -> Option<&AuthMechanismValue>
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".
sourcepub fn nesting_level(&self) -> Option<&NestingLevelValue>
pub fn nesting_level(&self) -> Option<&NestingLevelValue>
Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.
sourcepub fn extract_doc_id(&self) -> Option<&str>
pub fn extract_doc_id(&self) -> Option<&str>
Specifies the document ID. Use this setting when NestingLevel is set to "none".
Default value is "false".
sourcepub fn docs_to_investigate(&self) -> Option<&str>
pub fn docs_to_investigate(&self) -> Option<&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.
sourcepub fn auth_source(&self) -> Option<&str>
pub fn auth_source(&self) -> Option<&str>
The MongoDB database name. This setting isn't used when AuthType is set to "no".
The default is "admin".
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
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.
sourcepub fn secrets_manager_access_role_arn(&self) -> Option<&str>
pub fn secrets_manager_access_role_arn(&self) -> Option<&str>
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.
sourcepub fn secrets_manager_secret_id(&self) -> Option<&str>
pub fn secrets_manager_secret_id(&self) -> Option<&str>
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
source§impl MongoDbSettings
impl MongoDbSettings
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture MongoDbSettings.
Trait Implementations§
source§impl Clone for MongoDbSettings
impl Clone for MongoDbSettings
source§fn clone(&self) -> MongoDbSettings
fn clone(&self) -> MongoDbSettings
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for MongoDbSettings
impl Debug for MongoDbSettings
source§impl PartialEq<MongoDbSettings> for MongoDbSettings
impl PartialEq<MongoDbSettings> for MongoDbSettings
source§fn eq(&self, other: &MongoDbSettings) -> bool
fn eq(&self, other: &MongoDbSettings) -> bool
self and other values to be equal, and is used
by ==.