Package software.amazon.awscdk.services.dms

Class CfnEndpoint.DocDbSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnEndpoint.DocDbSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpoint.DocDbSettingsProperty>

Enclosing interface:

CfnEndpoint.DocDbSettingsProperty

@Stability(Stable)
public static final class CfnEndpoint.DocDbSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpoint.DocDbSettingsProperty>

A builder for CfnEndpoint.DocDbSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpoint.DocDbSettingsProperty	build()	Builds the configured instance.
CfnEndpoint.DocDbSettingsProperty.Builder	docsToInvestigate(Number docsToInvestigate)	Sets the value of CfnEndpoint.DocDbSettingsProperty.getDocsToInvestigate()
CfnEndpoint.DocDbSettingsProperty.Builder	extractDocId(Boolean extractDocId)	Sets the value of CfnEndpoint.DocDbSettingsProperty.getExtractDocId()
CfnEndpoint.DocDbSettingsProperty.Builder	extractDocId(IResolvable extractDocId)	Sets the value of CfnEndpoint.DocDbSettingsProperty.getExtractDocId()
CfnEndpoint.DocDbSettingsProperty.Builder	nestingLevel(String nestingLevel)	Sets the value of CfnEndpoint.DocDbSettingsProperty.getNestingLevel()
CfnEndpoint.DocDbSettingsProperty.Builder	secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)	Sets the value of CfnEndpoint.DocDbSettingsProperty.getSecretsManagerAccessRoleArn()
CfnEndpoint.DocDbSettingsProperty.Builder	secretsManagerSecretId(String secretsManagerSecretId)	Sets the value of CfnEndpoint.DocDbSettingsProperty.getSecretsManagerSecretId()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

docsToInvestigate

@Stability(Stable)
public CfnEndpoint.DocDbSettingsProperty.Builder docsToInvestigate(Number docsToInvestigate)

Sets the value of CfnEndpoint.DocDbSettingsProperty.getDocsToInvestigate()

Parameters:

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 .

Returns:

this

extractDocId

@Stability(Stable)
public CfnEndpoint.DocDbSettingsProperty.Builder extractDocId(Boolean extractDocId)

Sets the value of CfnEndpoint.DocDbSettingsProperty.getExtractDocId()

Parameters:

extractDocId - Specifies the document ID. Use this setting when NestingLevel is set to "none" . Default value is "false" .

Returns:

this

extractDocId

@Stability(Stable)
public CfnEndpoint.DocDbSettingsProperty.Builder extractDocId(IResolvable extractDocId)

Sets the value of CfnEndpoint.DocDbSettingsProperty.getExtractDocId()

Parameters:

extractDocId - Specifies the document ID. Use this setting when NestingLevel is set to "none" . Default value is "false" .

Returns:

this

nestingLevel

@Stability(Stable)
public CfnEndpoint.DocDbSettingsProperty.Builder nestingLevel(String nestingLevel)

Sets the value of CfnEndpoint.DocDbSettingsProperty.getNestingLevel()

Parameters:

nestingLevel - Specifies either document or table mode. Default value is "none" . Specify "none" to use document mode. Specify "one" to use table mode.

Returns:

this

secretsManagerAccessRoleArn

@Stability(Stable)
public CfnEndpoint.DocDbSettingsProperty.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)

Sets the value of CfnEndpoint.DocDbSettingsProperty.getSecretsManagerAccessRoleArn()

Parameters:

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

Returns:

this

secretsManagerSecretId

@Stability(Stable)
public CfnEndpoint.DocDbSettingsProperty.Builder secretsManagerSecretId(String secretsManagerSecretId)

Sets the value of CfnEndpoint.DocDbSettingsProperty.getSecretsManagerSecretId()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnEndpoint.DocDbSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpoint.DocDbSettingsProperty>

Returns:

a new instance of CfnEndpoint.DocDbSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided