Package software.amazon.awscdk.cfnpropertymixins.services.dms

Class CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.dms.CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointPropsMixin.MongoDbSettingsProperty>

Enclosing interface:

CfnEndpointPropsMixin.MongoDbSettingsProperty

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

A builder for CfnEndpointPropsMixin.MongoDbSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	authMechanism(String authMechanism)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getAuthMechanism()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	authSource(String authSource)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getAuthSource()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	authType(String authType)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getAuthType()
CfnEndpointPropsMixin.MongoDbSettingsProperty	build()	Builds the configured instance.
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	databaseName(String databaseName)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getDatabaseName()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	docsToInvestigate(String docsToInvestigate)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getDocsToInvestigate()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	extractDocId(String extractDocId)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getExtractDocId()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	nestingLevel(String nestingLevel)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getNestingLevel()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	password(String password)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getPassword()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	port(Number port)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getPort()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getSecretsManagerAccessRoleArn()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	secretsManagerSecretId(String secretsManagerSecretId)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getSecretsManagerSecretId()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	serverName(String serverName)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getServerName()
CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder	username(String username)	Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getUsername()

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

authMechanism

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder authMechanism(String authMechanism)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getAuthMechanism()

Parameters:

authMechanism - The authentication mechanism you use to access the MongoDB source endpoint. For the default value, in MongoDB version 2.x, "default" is "mongodb_cr" . For MongoDB version 3.x or later, "default" is "scram_sha_1" . This setting isn't used when AuthType is set to "no" .

Returns:

this

authSource

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder authSource(String authSource)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getAuthSource()

Parameters:

authSource - The MongoDB database name. This setting isn't used when AuthType is set to "no" . The default is "admin" .

Returns:

this

authType

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder authType(String authType)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getAuthType()

Parameters:

authType - The authentication type you use to access the MongoDB source endpoint. When set to "no" , user name and password parameters are not used and can be empty.

Returns:

this

databaseName

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder databaseName(String databaseName)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getDatabaseName()

Parameters:

databaseName - The database name on the MongoDB source endpoint.

Returns:

this

docsToInvestigate

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder docsToInvestigate(String docsToInvestigate)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.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 CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder extractDocId(String extractDocId)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.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 CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder nestingLevel(String nestingLevel)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.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

password

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder password(String password)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getPassword()

Parameters:

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

Returns:

this

port

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder port(Number port)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getPort()

Parameters:

port - The port value for the MongoDB source endpoint.

Returns:

this

secretsManagerAccessRoleArn

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.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 MongoDB 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 CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder secretsManagerSecretId(String secretsManagerSecretId)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getSecretsManagerSecretId()

Parameters:

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

Returns:

this

serverName

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder serverName(String serverName)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getServerName()

Parameters:

serverName - The name of the server on the MongoDB source endpoint.

Returns:

this

username

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty.Builder username(String username)

Sets the value of CfnEndpointPropsMixin.MongoDbSettingsProperty.getUsername()

Parameters:

username - The user name you use to access the MongoDB source endpoint.

Returns:

this

build

@Stability(Stable)
public CfnEndpointPropsMixin.MongoDbSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpointPropsMixin.MongoDbSettingsProperty>

Returns:

a new instance of CfnEndpointPropsMixin.MongoDbSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided