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

Class CfnEndpointPropsMixin.MySqlSettingsProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnEndpointPropsMixin.MySqlSettingsProperty

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

A builder for CfnEndpointPropsMixin.MySqlSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	afterConnectScript(String afterConnectScript)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getAfterConnectScript()
CfnEndpointPropsMixin.MySqlSettingsProperty	build()	Builds the configured instance.
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	cleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getCleanSourceMetadataOnMismatch()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	cleanSourceMetadataOnMismatch(IResolvable cleanSourceMetadataOnMismatch)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getCleanSourceMetadataOnMismatch()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	eventsPollInterval(Number eventsPollInterval)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getEventsPollInterval()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	maxFileSize(Number maxFileSize)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getMaxFileSize()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	parallelLoadThreads(Number parallelLoadThreads)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getParallelLoadThreads()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getSecretsManagerAccessRoleArn()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	secretsManagerSecretId(String secretsManagerSecretId)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getSecretsManagerSecretId()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	serverTimezone(String serverTimezone)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getServerTimezone()
CfnEndpointPropsMixin.MySqlSettingsProperty.Builder	targetDbType(String targetDbType)	Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getTargetDbType()

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

afterConnectScript

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder afterConnectScript(String afterConnectScript)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getAfterConnectScript()

Parameters:

afterConnectScript - Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.

For this parameter, provide the code of the script itself, not the name of a file containing the script.

Returns:

this

cleanSourceMetadataOnMismatch

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder cleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getCleanSourceMetadataOnMismatch()

Parameters:

cleanSourceMetadataOnMismatch - Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance.

Returns:

this

cleanSourceMetadataOnMismatch

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder cleanSourceMetadataOnMismatch(IResolvable cleanSourceMetadataOnMismatch)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getCleanSourceMetadataOnMismatch()

Parameters:

cleanSourceMetadataOnMismatch - Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance.

Returns:

this

eventsPollInterval

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder eventsPollInterval(Number eventsPollInterval)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getEventsPollInterval()

Parameters:

eventsPollInterval - Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.

Example: eventsPollInterval=5;

In the example, AWS DMS checks for changes in the binary logs every five seconds.

Returns:

this

maxFileSize

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder maxFileSize(Number maxFileSize)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getMaxFileSize()

Parameters:

maxFileSize - Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database. Example: maxFileSize=512

Returns:

this

parallelLoadThreads

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder parallelLoadThreads(Number parallelLoadThreads)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getParallelLoadThreads()

Parameters:

parallelLoadThreads - Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.

Example: parallelLoadThreads=1

Returns:

this

secretsManagerAccessRoleArn

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

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

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getSecretsManagerSecretId()

Parameters:

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

Returns:

this

serverTimezone

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder serverTimezone(String serverTimezone)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getServerTimezone()

Parameters:

serverTimezone - Specifies the time zone for the source MySQL database. Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

Returns:

this

targetDbType

@Stability(Stable)
public CfnEndpointPropsMixin.MySqlSettingsProperty.Builder targetDbType(String targetDbType)

Sets the value of CfnEndpointPropsMixin.MySqlSettingsProperty.getTargetDbType()

Parameters:

targetDbType - Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify SPECIFIC_DATABASE , specify the database name using the DatabaseName parameter of the Endpoint object.

Example: targetDbType=MULTIPLE_DATABASES

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnEndpointPropsMixin.MySqlSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided