Package software.amazon.awscdk.services.dms

Interface CfnEndpoint.DocDbSettingsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnEndpoint.DocDbSettingsProperty.Jsii$Proxy
Enclosing class:
CfnEndpoint
@Stability(Stable) public static interface CfnEndpoint.DocDbSettingsProperty extends software.amazon.jsii.JsiiSerializable
Provides information that defines a DocumentDB endpoint.

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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 DocDbSettingsProperty docDbSettingsProperty = DocDbSettingsProperty.builder()
         .docsToInvestigate(123)
         .extractDocId(false)
         .nestingLevel("nestingLevel")
         .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
         .secretsManagerSecretId("secretsManagerSecretId")
         .build();

  • Method Details

    • getDocsToInvestigate

      @Stability(Stable) @Nullable default Number getDocsToInvestigate()
      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 .

    • getExtractDocId

      @Stability(Stable) @Nullable default Object getExtractDocId()
      Specifies the document ID. Use this setting when NestingLevel is set to "none" .

      Default value is "false" .

    • getNestingLevel

      @Stability(Stable) @Nullable default String getNestingLevel()
      Specifies either document or table mode.

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

    • getSecretsManagerAccessRoleArn

      @Stability(Stable) @Nullable default String getSecretsManagerAccessRoleArn()
      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 .

      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 .

    • getSecretsManagerSecretId

      @Stability(Stable) @Nullable default String getSecretsManagerSecretId()
      The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.

    • builder

      @Stability(Stable) static CfnEndpoint.DocDbSettingsProperty.Builder builder()
      Returns:
      a CfnEndpoint.DocDbSettingsProperty.Builder of CfnEndpoint.DocDbSettingsProperty