Class CfnEndpoint.GcpMySQLSettingsProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEndpoint.GcpMySQLSettingsProperty>
- Enclosing interface:
- CfnEndpoint.GcpMySQLSettingsProperty
CfnEndpoint.GcpMySQLSettingsProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionafterConnectScript
(String afterConnectScript) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getAfterConnectScript()
build()
Builds the configured instance.cleanSourceMetadataOnMismatch
(Boolean cleanSourceMetadataOnMismatch) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getCleanSourceMetadataOnMismatch()
cleanSourceMetadataOnMismatch
(IResolvable cleanSourceMetadataOnMismatch) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getCleanSourceMetadataOnMismatch()
databaseName
(String databaseName) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getDatabaseName()
eventsPollInterval
(Number eventsPollInterval) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getEventsPollInterval()
maxFileSize
(Number maxFileSize) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getMaxFileSize()
parallelLoadThreads
(Number parallelLoadThreads) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getParallelLoadThreads()
Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getPassword()
Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getPort()
secretsManagerAccessRoleArn
(String secretsManagerAccessRoleArn) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getSecretsManagerAccessRoleArn()
secretsManagerSecretId
(String secretsManagerSecretId) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getSecretsManagerSecretId()
serverName
(String serverName) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getServerName()
serverTimezone
(String serverTimezone) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getServerTimezone()
Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getUsername()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
afterConnectScript
@Stability(Stable) public CfnEndpoint.GcpMySQLSettingsProperty.Builder afterConnectScript(String afterConnectScript) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.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 CfnEndpoint.GcpMySQLSettingsProperty.Builder cleanSourceMetadataOnMismatch(Boolean cleanSourceMetadataOnMismatch) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getCleanSourceMetadataOnMismatch()
- Parameters:
cleanSourceMetadataOnMismatch
- Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute tofalse
.- Returns:
this
-
cleanSourceMetadataOnMismatch
@Stability(Stable) public CfnEndpoint.GcpMySQLSettingsProperty.Builder cleanSourceMetadataOnMismatch(IResolvable cleanSourceMetadataOnMismatch) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getCleanSourceMetadataOnMismatch()
- Parameters:
cleanSourceMetadataOnMismatch
- Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute tofalse
.- Returns:
this
-
databaseName
@Stability(Stable) public CfnEndpoint.GcpMySQLSettingsProperty.Builder databaseName(String databaseName) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getDatabaseName()
- Parameters:
databaseName
- Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using theDatabaseName
request parameter on either theCreateEndpoint
orModifyEndpoint
API call. SpecifyingDatabaseName
when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the AWS DMS task.- Returns:
this
-
eventsPollInterval
@Stability(Stable) public CfnEndpoint.GcpMySQLSettingsProperty.Builder eventsPollInterval(Number eventsPollInterval) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.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 CfnEndpoint.GcpMySQLSettingsProperty.Builder maxFileSize(Number maxFileSize) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.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 CfnEndpoint.GcpMySQLSettingsProperty.Builder parallelLoadThreads(Number parallelLoadThreads) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.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
-
password
Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getPassword()
- Parameters:
password
- Endpoint connection password.- Returns:
this
-
port
Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getPort()
- Parameters:
port
- The port used by the endpoint database.- Returns:
this
-
secretsManagerAccessRoleArn
@Stability(Stable) public CfnEndpoint.GcpMySQLSettingsProperty.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.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 inSecretsManagerSecret.
The role must allow theiam: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 forUserName
,Password
,ServerName
, andPort
. You can't specify both.For more information on creating this
SecretsManagerSecret
, the correspondingSecretsManagerAccessRoleArn
, and theSecretsManagerSecretId
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.GcpMySQLSettingsProperty.Builder secretsManagerSecretId(String secretsManagerSecretId) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getSecretsManagerSecretId()
- Parameters:
secretsManagerSecretId
- The full ARN, partial ARN, or display name of theSecretsManagerSecret
that contains the MySQL endpoint connection details.- Returns:
this
-
serverName
@Stability(Stable) public CfnEndpoint.GcpMySQLSettingsProperty.Builder serverName(String serverName) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getServerName()
- Parameters:
serverName
- Endpoint TCP port.- Returns:
this
-
serverTimezone
@Stability(Stable) public CfnEndpoint.GcpMySQLSettingsProperty.Builder serverTimezone(String serverTimezone) Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getServerTimezone()
- Parameters:
serverTimezone
- Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks. Example:serverTimezone=US/Pacific;
- Returns:
this
-
username
Sets the value ofCfnEndpoint.GcpMySQLSettingsProperty.getUsername()
- Parameters:
username
- Endpoint connection user name.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnEndpoint.GcpMySQLSettingsProperty>
- Returns:
- a new instance of
CfnEndpoint.GcpMySQLSettingsProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-