#[non_exhaustive]pub struct DocDbSettingsBuilder { /* private fields */ }
Expand description
A builder for DocDbSettings
.
Implementations§
Source§impl DocDbSettingsBuilder
impl DocDbSettingsBuilder
Sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
The user name you use to access the DocumentDB source endpoint.
Sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
The user name you use to access the DocumentDB source endpoint.
Sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
The user name you use to access the DocumentDB source endpoint.
Sourcepub fn password(self, input: impl Into<String>) -> Self
pub fn password(self, input: impl Into<String>) -> Self
The password for the user account you use to access the DocumentDB source endpoint.
Sourcepub fn set_password(self, input: Option<String>) -> Self
pub fn set_password(self, input: Option<String>) -> Self
The password for the user account you use to access the DocumentDB source endpoint.
Sourcepub fn get_password(&self) -> &Option<String>
pub fn get_password(&self) -> &Option<String>
The password for the user account you use to access the DocumentDB source endpoint.
Sourcepub fn server_name(self, input: impl Into<String>) -> Self
pub fn server_name(self, input: impl Into<String>) -> Self
The name of the server on the DocumentDB source endpoint.
Sourcepub fn set_server_name(self, input: Option<String>) -> Self
pub fn set_server_name(self, input: Option<String>) -> Self
The name of the server on the DocumentDB source endpoint.
Sourcepub fn get_server_name(&self) -> &Option<String>
pub fn get_server_name(&self) -> &Option<String>
The name of the server on the DocumentDB source endpoint.
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port value for the DocumentDB source endpoint.
Sourcepub fn database_name(self, input: impl Into<String>) -> Self
pub fn database_name(self, input: impl Into<String>) -> Self
The database name on the DocumentDB source endpoint.
Sourcepub fn set_database_name(self, input: Option<String>) -> Self
pub fn set_database_name(self, input: Option<String>) -> Self
The database name on the DocumentDB source endpoint.
Sourcepub fn get_database_name(&self) -> &Option<String>
pub fn get_database_name(&self) -> &Option<String>
The database name on the DocumentDB source endpoint.
Sourcepub fn nesting_level(self, input: NestingLevelValue) -> Self
pub fn nesting_level(self, input: NestingLevelValue) -> Self
Specifies either document or table mode.
Default value is "none"
. Specify "none"
to use document mode. Specify "one"
to use table mode.
Sourcepub fn set_nesting_level(self, input: Option<NestingLevelValue>) -> Self
pub fn set_nesting_level(self, input: Option<NestingLevelValue>) -> Self
Specifies either document or table mode.
Default value is "none"
. Specify "none"
to use document mode. Specify "one"
to use table mode.
Sourcepub fn get_nesting_level(&self) -> &Option<NestingLevelValue>
pub fn get_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, input: bool) -> Self
pub fn extract_doc_id(self, input: bool) -> Self
Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
Default value is "false"
.
Sourcepub fn set_extract_doc_id(self, input: Option<bool>) -> Self
pub fn set_extract_doc_id(self, input: Option<bool>) -> Self
Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
Default value is "false"
.
Sourcepub fn get_extract_doc_id(&self) -> &Option<bool>
pub fn get_extract_doc_id(&self) -> &Option<bool>
Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
Default value is "false"
.
Sourcepub fn docs_to_investigate(self, input: i32) -> Self
pub fn docs_to_investigate(self, input: i32) -> Self
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 set_docs_to_investigate(self, input: Option<i32>) -> Self
pub fn set_docs_to_investigate(self, input: Option<i32>) -> Self
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 get_docs_to_investigate(&self) -> &Option<i32>
pub fn get_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
.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
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 set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
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 get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &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.
Sourcepub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self
pub fn secrets_manager_access_role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self
pub fn set_secrets_manager_access_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_secrets_manager_access_role_arn(&self) -> &Option<String>
pub fn get_secrets_manager_access_role_arn(&self) -> &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.
Sourcepub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self
pub fn secrets_manager_secret_id(self, input: impl Into<String>) -> Self
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the DocumentDB endpoint connection details.
Sourcepub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self
pub fn set_secrets_manager_secret_id(self, input: Option<String>) -> Self
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the DocumentDB endpoint connection details.
Sourcepub fn get_secrets_manager_secret_id(&self) -> &Option<String>
pub fn get_secrets_manager_secret_id(&self) -> &Option<String>
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the DocumentDB endpoint connection details.
Sourcepub fn use_update_look_up(self, input: bool) -> Self
pub fn use_update_look_up(self, input: bool) -> Self
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
.
Sourcepub fn set_use_update_look_up(self, input: Option<bool>) -> Self
pub fn set_use_update_look_up(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_use_update_look_up(&self) -> &Option<bool>
pub fn get_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
.
Sourcepub fn replicate_shard_collections(self, input: bool) -> Self
pub fn replicate_shard_collections(self, input: bool) -> Self
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
tonothing
. -
DMS automatically sets
useUpdateLookup
tofalse
.
Sourcepub fn set_replicate_shard_collections(self, input: Option<bool>) -> Self
pub fn set_replicate_shard_collections(self, input: Option<bool>) -> Self
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
tonothing
. -
DMS automatically sets
useUpdateLookup
tofalse
.
Sourcepub fn get_replicate_shard_collections(&self) -> &Option<bool>
pub fn get_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
tonothing
. -
DMS automatically sets
useUpdateLookup
tofalse
.
Sourcepub fn build(self) -> DocDbSettings
pub fn build(self) -> DocDbSettings
Consumes the builder and constructs a DocDbSettings
.
Trait Implementations§
Source§impl Clone for DocDbSettingsBuilder
impl Clone for DocDbSettingsBuilder
Source§fn clone(&self) -> DocDbSettingsBuilder
fn clone(&self) -> DocDbSettingsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DocDbSettingsBuilder
impl Debug for DocDbSettingsBuilder
Source§impl Default for DocDbSettingsBuilder
impl Default for DocDbSettingsBuilder
Source§fn default() -> DocDbSettingsBuilder
fn default() -> DocDbSettingsBuilder
Source§impl PartialEq for DocDbSettingsBuilder
impl PartialEq for DocDbSettingsBuilder
impl StructuralPartialEq for DocDbSettingsBuilder
Auto Trait Implementations§
impl Freeze for DocDbSettingsBuilder
impl RefUnwindSafe for DocDbSettingsBuilder
impl Send for DocDbSettingsBuilder
impl Sync for DocDbSettingsBuilder
impl Unpin for DocDbSettingsBuilder
impl UnwindSafe for DocDbSettingsBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);