Struct aws_sdk_databasemigration::types::DocDbSettings

#[non_exhaustive]
pub struct DocDbSettings {

    pub username: Option<String>,
    pub password: Option<String>,
    pub server_name: Option<String>,
    pub port: Option<i32>,
    pub database_name: Option<String>,
    pub nesting_level: Option<NestingLevelValue>,
    pub extract_doc_id: Option<bool>,
    pub docs_to_investigate: Option<i32>,
    pub kms_key_id: Option<String>,
    pub secrets_manager_access_role_arn: Option<String>,
    pub secrets_manager_secret_id: Option<String>,
    pub use_update_look_up: Option<bool>,
    pub replicate_shard_collections: Option<bool>,
}

Provides information that defines a DocumentDB endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

username: Option<String>

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

password: Option<String>

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

server_name: Option<String>

The name of the server on the DocumentDB source endpoint.

port: Option<i32>

The port value for the DocumentDB source endpoint.

database_name: Option<String>

The database name on the DocumentDB source endpoint.

nesting_level: Option<NestingLevelValue>

Specifies either document or table mode.

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

extract_doc_id: Option<bool>

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

Default value is "false".

docs_to_investigate: Option<i32>

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.

kms_key_id: Option<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.

secrets_manager_access_role_arn: Option<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 DocumentDB 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.

secrets_manager_secret_id: Option<String>

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

use_update_look_up: Option<bool>

If true, DMS retrieves the entire document from the DocumentDB 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.

replicate_shard_collections: Option<bool>

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.

Implementations

impl DocDbSettings

pub fn username(&self) -> Option<&str>

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

pub fn password(&self) -> Option<&str>

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

pub fn server_name(&self) -> Option<&str>

The name of the server on the DocumentDB source endpoint.

pub fn port(&self) -> Option<i32>

The port value for the DocumentDB source endpoint.

pub fn database_name(&self) -> Option<&str>

The database name on the DocumentDB source endpoint.

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.

pub fn extract_doc_id(&self) -> Option<bool>

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

Default value is "false".

pub fn docs_to_investigate(&self) -> Option<i32>

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.

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.

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

pub fn secrets_manager_secret_id(&self) -> Option<&str>

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

pub fn use_update_look_up(&self) -> Option<bool>

If true, DMS retrieves the entire document from the DocumentDB 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.

pub fn replicate_shard_collections(&self) -> Option<bool>

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.

impl DocDbSettings

pub fn builder() -> DocDbSettingsBuilder

Creates a new builder-style object to manufacture DocDbSettings.

Trait Implementations

impl Clone for DocDbSettings

fn clone(&self) -> DocDbSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocDbSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DocDbSettings> for DocDbSettings

fn eq(&self, other: &DocDbSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocDbSettings