MySQLSettings (AWS Java SDK :: Services :: AWS Database Migration Service 2.16.60 API)

java.lang.Object
- software.amazon.awssdk.services.databasemigration.model.MySQLSettings

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<MySQLSettings.Builder,MySQLSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class MySQLSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MySQLSettings.Builder,MySQLSettings>

Provides information that defines a MySQL endpoint.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MySQLSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MySQLSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`afterConnectScript()` Specifies a script to run immediately after AWS DMS connects to the endpoint.
`static MySQLSettings.Builder`	`builder()`
`Boolean`	`cleanSourceMetadataOnMismatch()` Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster.
`String`	`databaseName()` Database name for the endpoint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`eventsPollInterval()` Specifies how often to check the binary log for new changes/events when the database is idle.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxFileSize()` Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
`Integer`	`parallelLoadThreads()` Improves performance when loading data into the MySQL-compatible target database.
`String`	`password()` Endpoint connection password.
`Integer`	`port()` Endpoint TCP port.
`List<SdkField<?>>`	`sdkFields()`
`String`	`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`.
`String`	`secretsManagerSecretId()` The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
`static Class<? extends MySQLSettings.Builder>`	`serializableBuilderClass()`
`String`	`serverName()` Fully qualified domain name of the endpoint.
`String`	`serverTimezone()` Specifies the time zone for the source MySQL database.
`TargetDbType`	`targetDbType()` Specifies where to migrate source tables on the target, either to a single database or multiple databases.
`String`	`targetDbTypeAsString()` Specifies where to migrate source tables on the target, either to a single database or multiple databases.
`MySQLSettings.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`username()` Endpoint connection user name.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - afterConnectScript
```
public final String 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.
    
    Returns:
    
    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.
  - cleanSourceMetadataOnMismatch
```
public final Boolean cleanSourceMetadataOnMismatch()
```
    Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    
    Returns:
    
    Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
  - databaseName
```
public final String databaseName()
```
    Database name for the endpoint.
    
    Returns:
    
    Database name for the endpoint.
  - eventsPollInterval
```
public final Integer eventsPollInterval()
```
    Specifies how often to check the binary log for new changes/events when the database is idle.
    
    Example: eventsPollInterval=5;
    
    In the example, AWS DMS checks for changes in the binary logs every five seconds.
    
    Returns:
    
    Specifies how often to check the binary log for new changes/events when the database is idle.
    
    Example: eventsPollInterval=5;
    
    In the example, AWS DMS checks for changes in the binary logs every five seconds.
  - targetDbType
```
public final TargetDbType targetDbType()
```
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    
    Example: targetDbType=MULTIPLE_DATABASES
    
    If the service returns an enum value that is not available in the current SDK version, targetDbType will return TargetDbType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetDbTypeAsString().
    
    Returns:
    
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    
    Example: targetDbType=MULTIPLE_DATABASES
    
    See Also:
    
    TargetDbType
  - targetDbTypeAsString
```
public final String targetDbTypeAsString()
```
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    
    Example: targetDbType=MULTIPLE_DATABASES
    
    If the service returns an enum value that is not available in the current SDK version, targetDbType will return TargetDbType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetDbTypeAsString().
    
    Returns:
    
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    
    Example: targetDbType=MULTIPLE_DATABASES
    
    See Also:
    
    TargetDbType
  - maxFileSize
```
public final Integer maxFileSize()
```
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    
    Example: maxFileSize=512
    
    Returns:
    
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    
    Example: maxFileSize=512
  - parallelLoadThreads
```
public final Integer 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.
    
    Example: parallelLoadThreads=1
    
    Returns:
    
    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.
    
    Example: parallelLoadThreads=1
  - password
```
public final String password()
```
    Endpoint connection password.
    
    Returns:
    
    Endpoint connection password.
  - port
```
public final Integer port()
```
    Endpoint TCP port.
    
    Returns:
    
    Endpoint TCP port.
  - serverName
```
public final String serverName()
```
    Fully qualified domain name of the endpoint.
    
    Returns:
    
    Fully qualified domain name of the endpoint.
  - serverTimezone
```
public final String serverTimezone()
```
    Specifies the time zone for the source MySQL database.
    
    Example: serverTimezone=US/Pacific;
    
    Note: Do not enclose time zones in single quotes.
    
    Returns:
    
    Specifies the time zone for the source MySQL database.
    
    Example: serverTimezone=US/Pacific;
    
    Note: Do not enclose time zones in single quotes.
  - username
```
public final String username()
```
    Endpoint connection user name.
    
    Returns:
    
    Endpoint connection user name.
  - secretsManagerAccessRoleArn
```
public final String 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. 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 and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.
    
    Returns:
    
    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. 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 and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.
  - secretsManagerSecretId
```
public final String secretsManagerSecretId()
```
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    
    Returns:
    
    The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
  - toBuilder
```
public MySQLSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MySQLSettings.Builder,MySQLSettings>
  - builder
```
public static MySQLSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MySQLSettings.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MySQLSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

afterConnectScript

cleanSourceMetadataOnMismatch

databaseName

eventsPollInterval

targetDbType

targetDbTypeAsString

maxFileSize

parallelLoadThreads

password

port

serverName

serverTimezone

username

secretsManagerAccessRoleArn

secretsManagerSecretId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields