Class CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnEndpoint.MongoDbSettingsProperty
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnEndpoint.MongoDbSettingsProperty
CfnEndpoint.MongoDbSettingsProperty
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dms.CfnEndpoint.MongoDbSettingsProperty
CfnEndpoint.MongoDbSettingsProperty.Builder, CfnEndpoint.MongoDbSettingsProperty.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnEndpoint.MongoDbSettingsProperty.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
The authentication mechanism you use to access the MongoDB source endpoint.final String
The MongoDB database name.final String
The authentication type you use to access the MongoDB source endpoint.final String
The database name on the MongoDB source endpoint.final String
Indicates the number of documents to preview to determine the document organization.final String
Specifies the document ID.final String
Specifies either document or table mode.final String
The password for the user account you use to access the MongoDB source endpoint.final Number
getPort()
The port value for the MongoDB source endpoint.final String
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value inSecretsManagerSecret
.final String
The full ARN, partial ARN, or display name of theSecretsManagerSecret
that contains the MongoDB endpoint connection details.final String
The name of the server on the MongoDB source endpoint.final String
The user name you use to access the MongoDB source endpoint.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnEndpoint.MongoDbSettingsProperty.Builder
.
-
-
Method Details
-
getAuthMechanism
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
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 whenAuthType
is set to"no"
.- Specified by:
getAuthMechanism
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getAuthSource
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The MongoDB database name. This setting isn't used whenAuthType
is set to"no"
.The default is
"admin"
.- Specified by:
getAuthSource
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getAuthType
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The authentication type you use to access the MongoDB source endpoint.When set to
"no"
, user name and password parameters are not used and can be empty.- Specified by:
getAuthType
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getDatabaseName
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The database name on the MongoDB source endpoint.- Specified by:
getDatabaseName
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getDocsToInvestigate
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
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 is1000
.- Specified by:
getDocsToInvestigate
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getExtractDocId
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
Specifies the document ID. Use this setting whenNestingLevel
is set to"none"
.Default value is
"false"
.- Specified by:
getExtractDocId
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getNestingLevel
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
Specifies either document or table mode.Default value is
"none"
. Specify"none"
to use document mode. Specify"one"
to use table mode.- Specified by:
getNestingLevel
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getPassword
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The password for the user account you use to access the MongoDB source endpoint.- Specified by:
getPassword
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getPort
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The port value for the MongoDB source endpoint.- Specified by:
getPort
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getSecretsManagerAccessRoleArn
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value inSecretsManagerSecret
.The role must allow the
iam:PassRole
action.SecretsManagerSecret
has the value of the AWS 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 forUserName
,Password
,ServerName
, andPort
. You can't specify both.For more information on creating this
SecretsManagerSecret
, the correspondingSecretsManagerAccessRoleArn
, and theSecretsManagerSecretId
that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .- Specified by:
getSecretsManagerAccessRoleArn
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getSecretsManagerSecretId
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The full ARN, partial ARN, or display name of theSecretsManagerSecret
that contains the MongoDB endpoint connection details.- Specified by:
getSecretsManagerSecretId
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getServerName
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The name of the server on the MongoDB source endpoint.- Specified by:
getServerName
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
getUsername
Description copied from interface:CfnEndpoint.MongoDbSettingsProperty
The user name you use to access the MongoDB source endpoint.- Specified by:
getUsername
in interfaceCfnEndpoint.MongoDbSettingsProperty
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-