Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DMS.Types.DocDbSettings

Description

Synopsis

data DocDbSettings = DocDbSettings' {
- serverName :: Maybe Text
- secretsManagerAccessRoleArn :: Maybe Text
- username :: Maybe Text
- kmsKeyId :: Maybe Text
- password :: Maybe (Sensitive Text)
- nestingLevel :: Maybe NestingLevelValue
- databaseName :: Maybe Text
- docsToInvestigate :: Maybe Int
- secretsManagerSecretId :: Maybe Text
- extractDocId :: Maybe Bool
- port :: Maybe Int
}
newDocDbSettings :: DocDbSettings
docDbSettings_serverName :: Lens' DocDbSettings (Maybe Text)
docDbSettings_secretsManagerAccessRoleArn :: Lens' DocDbSettings (Maybe Text)
docDbSettings_username :: Lens' DocDbSettings (Maybe Text)
docDbSettings_kmsKeyId :: Lens' DocDbSettings (Maybe Text)
docDbSettings_password :: Lens' DocDbSettings (Maybe Text)
docDbSettings_nestingLevel :: Lens' DocDbSettings (Maybe NestingLevelValue)
docDbSettings_databaseName :: Lens' DocDbSettings (Maybe Text)
docDbSettings_docsToInvestigate :: Lens' DocDbSettings (Maybe Int)
docDbSettings_secretsManagerSecretId :: Lens' DocDbSettings (Maybe Text)
docDbSettings_extractDocId :: Lens' DocDbSettings (Maybe Bool)
docDbSettings_port :: Lens' DocDbSettings (Maybe Int)

Documentation

data DocDbSettings Source #

Provides information that defines a DocumentDB endpoint.

See: newDocDbSettings smart constructor.

Constructors

DocDbSettings'

Fields

serverName :: Maybe Text
The name of the server on the DocumentDB source endpoint.
secretsManagerAccessRoleArn :: Maybe Text
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.
username :: Maybe Text
The user name you use to access the DocumentDB source endpoint.
kmsKeyId :: Maybe Text
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.
password :: Maybe (Sensitive Text)
The password for the user account you use to access the DocumentDB source endpoint.
nestingLevel :: Maybe NestingLevelValue
Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode. Specify "one" to use table mode.
databaseName :: Maybe Text
The database name on the DocumentDB source endpoint.
docsToInvestigate :: Maybe Int
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.
secretsManagerSecretId :: Maybe Text
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
extractDocId :: Maybe Bool
Specifies the document ID. Use this setting when NestingLevel is set to "none".
Default value is "false".
port :: Maybe Int
The port value for the DocumentDB source endpoint.

Instances

Instances details

Eq DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings Methods (==) :: DocDbSettings -> DocDbSettings -> Bool # (/=) :: DocDbSettings -> DocDbSettings -> Bool #
Show DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings Methods showsPrec :: Int -> DocDbSettings -> ShowS # show :: DocDbSettings -> String # showList :: [DocDbSettings] -> ShowS #
Generic DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings Associated Types type Rep DocDbSettings :: Type -> Type # Methods from :: DocDbSettings -> Rep DocDbSettings x # to :: Rep DocDbSettings x -> DocDbSettings #
NFData DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings Methods rnf :: DocDbSettings -> () #
Hashable DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings Methods hashWithSalt :: Int -> DocDbSettings -> Int # hash :: DocDbSettings -> Int #
ToJSON DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings Methods toJSON :: DocDbSettings -> Value # toEncoding :: DocDbSettings -> Encoding # toJSONList :: [DocDbSettings] -> Value # toEncodingList :: [DocDbSettings] -> Encoding #
FromJSON DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings Methods parseJSON :: Value -> Parser DocDbSettings # parseJSONList :: Value -> Parser [DocDbSettings] #
type Rep DocDbSettings Source #
Instance details Defined in Amazonka.DMS.Types.DocDbSettings type Rep DocDbSettings = D1 ('MetaData "DocDbSettings" "Amazonka.DMS.Types.DocDbSettings" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DocDbSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "secretsManagerAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) :: ((S1 ('MetaSel ('Just "nestingLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NestingLevelValue)) :: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "docsToInvestigate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "secretsManagerSecretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "extractDocId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))

newDocDbSettings :: DocDbSettings Source #

Create a value of DocDbSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:serverName:DocDbSettings', docDbSettings_serverName - The name of the server on the DocumentDB source endpoint.

$sel:secretsManagerAccessRoleArn:DocDbSettings', docDbSettings_secretsManagerAccessRoleArn - 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.

$sel:username:DocDbSettings', docDbSettings_username - The user name you use to access the DocumentDB source endpoint.

$sel:kmsKeyId:DocDbSettings', docDbSettings_kmsKeyId - 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.

$sel:password:DocDbSettings', docDbSettings_password - The password for the user account you use to access the DocumentDB source endpoint.

$sel:nestingLevel:DocDbSettings', docDbSettings_nestingLevel - Specifies either document or table mode.

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

$sel:databaseName:DocDbSettings', docDbSettings_databaseName - The database name on the DocumentDB source endpoint.

$sel:docsToInvestigate:DocDbSettings', docDbSettings_docsToInvestigate - 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.

$sel:secretsManagerSecretId:DocDbSettings', docDbSettings_secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.

$sel:extractDocId:DocDbSettings', docDbSettings_extractDocId - Specifies the document ID. Use this setting when NestingLevel is set to "none".

Default value is "false".

$sel:port:DocDbSettings', docDbSettings_port - The port value for the DocumentDB source endpoint.

docDbSettings_serverName :: Lens' DocDbSettings (Maybe Text) Source #

The name of the server on the DocumentDB source endpoint.

docDbSettings_secretsManagerAccessRoleArn :: Lens' DocDbSettings (Maybe Text) Source #

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.

docDbSettings_username :: Lens' DocDbSettings (Maybe Text) Source #

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

docDbSettings_kmsKeyId :: Lens' DocDbSettings (Maybe Text) Source #

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.

docDbSettings_password :: Lens' DocDbSettings (Maybe Text) Source #

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

docDbSettings_nestingLevel :: Lens' DocDbSettings (Maybe NestingLevelValue) Source #

Specifies either document or table mode.

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

docDbSettings_databaseName :: Lens' DocDbSettings (Maybe Text) Source #

The database name on the DocumentDB source endpoint.

docDbSettings_docsToInvestigate :: Lens' DocDbSettings (Maybe Int) Source #

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.

docDbSettings_secretsManagerSecretId :: Lens' DocDbSettings (Maybe Text) Source #

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

docDbSettings_extractDocId :: Lens' DocDbSettings (Maybe Bool) Source #

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

Default value is "false".

docDbSettings_port :: Lens' DocDbSettings (Maybe Int) Source #

The port value for the DocumentDB source endpoint.