Struct aws_sdk_databasemigration::model::DocDbSettings
source · [−]#[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>,
}
Expand description
Provides information that defines a DocumentDB endpoint.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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.
Implementations
sourceimpl DocDbSettings
impl DocDbSettings
sourcepub fn username(&self) -> Option<&str>
pub fn username(&self) -> Option<&str>
The user name you use to access the DocumentDB 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 DocumentDB source endpoint.
sourcepub fn server_name(&self) -> Option<&str>
pub fn server_name(&self) -> Option<&str>
The name of the server on the DocumentDB source endpoint.
sourcepub fn database_name(&self) -> Option<&str>
pub fn database_name(&self) -> Option<&str>
The database name on the DocumentDB source endpoint.
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<bool>
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"
.
sourcepub fn docs_to_investigate(&self) -> Option<i32>
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
.
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 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) -> 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 DocumentDB endpoint connection details.
sourceimpl DocDbSettings
impl DocDbSettings
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DocDbSettings
Trait Implementations
sourceimpl Clone for DocDbSettings
impl Clone for DocDbSettings
sourcefn clone(&self) -> DocDbSettings
fn clone(&self) -> DocDbSettings
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DocDbSettings
impl Debug for DocDbSettings
sourceimpl PartialEq<DocDbSettings> for DocDbSettings
impl PartialEq<DocDbSettings> for DocDbSettings
sourcefn eq(&self, other: &DocDbSettings) -> bool
fn eq(&self, other: &DocDbSettings) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DocDbSettings) -> bool
fn ne(&self, other: &DocDbSettings) -> bool
This method tests for !=
.
impl StructuralPartialEq for DocDbSettings
Auto Trait Implementations
impl RefUnwindSafe for DocDbSettings
impl Send for DocDbSettings
impl Sync for DocDbSettings
impl Unpin for DocDbSettings
impl UnwindSafe for DocDbSettings
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more