Package software.amazon.awscdk.services.dms

Class CfnEndpoint.DocDbSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.dms.CfnEndpoint.DocDbSettingsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnEndpoint.DocDbSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpoint.DocDbSettingsProperty

@Stability(Stable)
@Internal
public static final class CfnEndpoint.DocDbSettingsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEndpoint.DocDbSettingsProperty

An implementation for CfnEndpoint.DocDbSettingsProperty

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.DocDbSettingsProperty

CfnEndpoint.DocDbSettingsProperty.Builder, CfnEndpoint.DocDbSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEndpoint.DocDbSettingsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEndpoint.DocDbSettingsProperty.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 Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Number	getDocsToInvestigate()	Indicates the number of documents to preview to determine the document organization.
final Object	getExtractDocId()	Specifies the document ID.
final String	getNestingLevel()	Specifies either document or table mode.
final 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 .
final String	getSecretsManagerSecretId()	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(CfnEndpoint.DocDbSettingsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEndpoint.DocDbSettingsProperty.Builder.

Method Details

getDocsToInvestigate

public final Number getDocsToInvestigate()

Description copied from interface: CfnEndpoint.DocDbSettingsProperty

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 .

Specified by:

getDocsToInvestigate in interface CfnEndpoint.DocDbSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-docstoinvestigate

getExtractDocId

public final Object getExtractDocId()

Description copied from interface: CfnEndpoint.DocDbSettingsProperty

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

Default value is "false" .

Returns union: either Boolean or IResolvable

Specified by:

getExtractDocId in interface CfnEndpoint.DocDbSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-extractdocid

getNestingLevel

public final String getNestingLevel()

Description copied from interface: CfnEndpoint.DocDbSettingsProperty

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 interface CfnEndpoint.DocDbSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-nestinglevel

getSecretsManagerAccessRoleArn

public final String getSecretsManagerAccessRoleArn()

Description copied from interface: CfnEndpoint.DocDbSettingsProperty

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 .

Specified by:

getSecretsManagerAccessRoleArn in interface CfnEndpoint.DocDbSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanageraccessrolearn

getSecretsManagerSecretId

public final String getSecretsManagerSecretId()

Description copied from interface: CfnEndpoint.DocDbSettingsProperty

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

Specified by:

getSecretsManagerSecretId in interface CfnEndpoint.DocDbSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html#cfn-dms-endpoint-docdbsettings-secretsmanagersecretid

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object