Interface CfnEndpoint.IDocDbSettingsProperty
Provides information that defines a DocumentDB endpoint.
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public interface IDocDbSettingsProperty
Syntax (vb)
Public Interface IDocDbSettingsProperty
Remarks
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var docDbSettingsProperty = new DocDbSettingsProperty {
DocsToInvestigate = 123,
ExtractDocId = false,
NestingLevel = "nestingLevel",
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId"
};
Synopsis
Properties
DocsToInvestigate | Indicates the number of documents to preview to determine the document organization. |
ExtractDocId | Specifies the document ID. Use this setting when |
NestingLevel | Specifies either document or table mode. |
SecretsManagerAccessRoleArn | 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 in |
SecretsManagerSecretId | The full ARN, partial ARN, or display name of the |
Properties
DocsToInvestigate
Indicates the number of documents to preview to determine the document organization.
virtual Nullable<double> DocsToInvestigate { get; }
Property Value
System.Nullable<System.Double>
Remarks
Use this setting when NestingLevel
is set to "one"
.
Must be a positive value greater than 0
. Default value is 1000
.
ExtractDocId
Specifies the document ID. Use this setting when NestingLevel
is set to "none"
.
virtual object ExtractDocId { get; }
Property Value
System.Object
Remarks
NestingLevel
Specifies either document or table mode.
virtual string NestingLevel { get; }
Property Value
System.String
Remarks
Default value is "none"
. Specify "none"
to use document mode. Specify "one"
to use table mode.
SecretsManagerAccessRoleArn
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 in SecretsManagerSecret
.
virtual string SecretsManagerAccessRoleArn { get; }
Property Value
System.String
Remarks
The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the AWS 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
, the corresponding SecretsManagerAccessRoleArn
, and the SecretsManagerSecretId
that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerSecretId
The full ARN, partial ARN, or display name of the SecretsManagerSecret
that contains the DocumentDB endpoint connection details.
virtual string SecretsManagerSecretId { get; }
Property Value
System.String